Interface Api

Hierarchy

  • Api

Properties

access cluster nodes pools storage version

Properties

access

access: { acl: { $get: any; $put: any }; domains: { $: any; $get: any; $post: any }; groups: { $: any; $get: any; $post: any }; openid: { auth-url: { $post: any }; login: { $post: any }; $get: any }; password: { $put: any }; permissions: { $get: any }; roles: { $: any; $get: any; $post: any }; tfa: { $: any; $get: any; $post: any }; ticket: { $get: any; $post: any }; users: { $: any; $get: any; $post: any }; $get: any }

Type declaration

  • acl: { $get: any; $put: any }
    • $get:function
    • $put:function
      • $put(param: { delete?: boolean; groups?: string; path: string; propagate?: boolean; roles: string; tokens?: string; users?: string }): Promise<null>

      • Update Access Control List (add or remove permissions). PUT /access/acl

        Allowtoken

        1

        Permissions

        Parameters

        • param: { delete?: boolean; groups?: string; path: string; propagate?: boolean; roles: string; tokens?: string; users?: string }
          • Optional delete?: boolean
          • Optional groups?: string
          • path: string
          • Optional propagate?: boolean
          • roles: string
          • Optional tokens?: string
          • Optional users?: string

        Returns Promise<null>

  • domains: { $: any; $get: any; $post: any }
    • $:function
      • $(realm: string): { sync: { $post: any }; $delete: any; $get: any; $put: any }

      • Parameters

        • realm: string

        Returns { sync: { $post: any }; $delete: any; $get: any; $put: any }

        • sync: { $post: any }
          • $post:function
            • $post(param?: { dry-run?: boolean; enable-new?: boolean; full?: boolean; purge?: boolean; scope?: Tscope_1 }): Promise<string>

            • Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting. POST /access/domains/{realm}/sync

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { dry-run?: boolean; enable-new?: boolean; full?: boolean; purge?: boolean; scope?: Tscope_1 }
                • Optional dry-run?: boolean
                • Optional enable-new?: boolean
                • Optional full?: boolean
                • Optional purge?: boolean
                • Optional scope?: Tscope_1

              Returns Promise<string>

        • $delete:function
          • $delete(): Promise<null>

          • Delete an authentication server. DELETE /access/domains/{realm}

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
          • $get(): Promise<any>

          • Get auth server configuration. GET /access/domains/{realm}

            Allowtoken

            1

            Permissions

            Returns Promise<any>

        • $put:function
          • $put(param?: { autocreate?: boolean; base_dn?: string; bind_dn?: string; capath?: string; case-sensitive?: boolean; cert?: string; certkey?: string; client-id?: string; client-key?: string; comment?: string; default?: boolean; delete?: string; digest?: string; domain?: string; filter?: string; group_classes?: string; group_dn?: string; group_filter?: string; group_name_attr?: string; issuer-url?: string; mode?: Tmode_1; password?: string; port?: number; secure?: boolean; server1?: string; server2?: string; sslversion?: Tsslversion; sync-defaults-options?: string; sync_attributes?: string; tfa?: string; user_attr?: string; user_classes?: string; verify?: boolean }): Promise<null>

          • Update authentication server settings. PUT /access/domains/{realm}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { autocreate?: boolean; base_dn?: string; bind_dn?: string; capath?: string; case-sensitive?: boolean; cert?: string; certkey?: string; client-id?: string; client-key?: string; comment?: string; default?: boolean; delete?: string; digest?: string; domain?: string; filter?: string; group_classes?: string; group_dn?: string; group_filter?: string; group_name_attr?: string; issuer-url?: string; mode?: Tmode_1; password?: string; port?: number; secure?: boolean; server1?: string; server2?: string; sslversion?: Tsslversion; sync-defaults-options?: string; sync_attributes?: string; tfa?: string; user_attr?: string; user_classes?: string; verify?: boolean }
              • Optional autocreate?: boolean
              • Optional base_dn?: string
              • Optional bind_dn?: string
              • Optional capath?: string
              • Optional case-sensitive?: boolean
              • Optional cert?: string
              • Optional certkey?: string
              • Optional client-id?: string
              • Optional client-key?: string
              • Optional comment?: string
              • Optional default?: boolean
              • Optional delete?: string
              • Optional digest?: string
              • Optional domain?: string
              • Optional filter?: string
              • Optional group_classes?: string
              • Optional group_dn?: string
              • Optional group_filter?: string
              • Optional group_name_attr?: string
              • Optional issuer-url?: string
              • Optional mode?: Tmode_1
              • Optional password?: string
              • Optional port?: number
              • Optional secure?: boolean
              • Optional server1?: string
              • Optional server2?: string
              • Optional sslversion?: Tsslversion
              • Optional sync-defaults-options?: string
              • Optional sync_attributes?: string
              • Optional tfa?: string
              • Optional user_attr?: string
              • Optional user_classes?: string
              • Optional verify?: boolean

            Returns Promise<null>

    • $get:function
    • $post:function
      • $post(param: { autocreate?: boolean; base_dn?: string; bind_dn?: string; capath?: string; case-sensitive?: boolean; cert?: string; certkey?: string; client-id?: string; client-key?: string; comment?: string; default?: boolean; domain?: string; filter?: string; group_classes?: string; group_dn?: string; group_filter?: string; group_name_attr?: string; issuer-url?: string; mode?: Tmode_1; password?: string; port?: number; realm: string; secure?: boolean; server1?: string; server2?: string; sslversion?: Tsslversion; sync-defaults-options?: string; sync_attributes?: string; tfa?: string; type: Ttype_19; user_attr?: string; user_classes?: string; username-claim?: Tusernameclaim; verify?: boolean }): Promise<null>

      • Add an authentication server. POST /access/domains

        Allowtoken

        1

        Permissions

        Parameters

        • param: { autocreate?: boolean; base_dn?: string; bind_dn?: string; capath?: string; case-sensitive?: boolean; cert?: string; certkey?: string; client-id?: string; client-key?: string; comment?: string; default?: boolean; domain?: string; filter?: string; group_classes?: string; group_dn?: string; group_filter?: string; group_name_attr?: string; issuer-url?: string; mode?: Tmode_1; password?: string; port?: number; realm: string; secure?: boolean; server1?: string; server2?: string; sslversion?: Tsslversion; sync-defaults-options?: string; sync_attributes?: string; tfa?: string; type: Ttype_19; user_attr?: string; user_classes?: string; username-claim?: Tusernameclaim; verify?: boolean }
          • Optional autocreate?: boolean
          • Optional base_dn?: string
          • Optional bind_dn?: string
          • Optional capath?: string
          • Optional case-sensitive?: boolean
          • Optional cert?: string
          • Optional certkey?: string
          • Optional client-id?: string
          • Optional client-key?: string
          • Optional comment?: string
          • Optional default?: boolean
          • Optional domain?: string
          • Optional filter?: string
          • Optional group_classes?: string
          • Optional group_dn?: string
          • Optional group_filter?: string
          • Optional group_name_attr?: string
          • Optional issuer-url?: string
          • Optional mode?: Tmode_1
          • Optional password?: string
          • Optional port?: number
          • realm: string
          • Optional secure?: boolean
          • Optional server1?: string
          • Optional server2?: string
          • Optional sslversion?: Tsslversion
          • Optional sync-defaults-options?: string
          • Optional sync_attributes?: string
          • Optional tfa?: string
          • type: Ttype_19
          • Optional user_attr?: string
          • Optional user_classes?: string
          • Optional username-claim?: Tusernameclaim
          • Optional verify?: boolean

        Returns Promise<null>

  • groups: { $: any; $get: any; $post: any }
    • $:function
      • $(groupid: string): { $delete: any; $get: any; $put: any }

      • Parameters

        • groupid: string

        Returns { $delete: any; $get: any; $put: any }

        • $delete:function
          • $delete(): Promise<null>

          • Delete group. DELETE /access/groups/{groupid}

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
        • $put:function
          • $put(param?: { comment?: string }): Promise<null>

          • Update group data. PUT /access/groups/{groupid}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { comment?: string }
              • Optional comment?: string

            Returns Promise<null>

    • $get:function
    • $post:function
      • $post(param: { comment?: string; groupid: string }): Promise<null>

      • Create new group. POST /access/groups

        Allowtoken

        1

        Permissions

        Parameters

        • param: { comment?: string; groupid: string }
          • Optional comment?: string
          • groupid: string

        Returns Promise<null>

  • openid: { auth-url: { $post: any }; login: { $post: any }; $get: any }
    • auth-url: { $post: any }
      • $post:function
        • $post(param: { realm: string; redirect-url: string }): Promise<string>

        • Get the OpenId Authorization Url for the specified realm. POST /access/openid/auth-url

          Allowtoken

          1

          Permissions

          Parameters

          • param: { realm: string; redirect-url: string }
            • realm: string
            • redirect-url: string

          Returns Promise<string>

    • login: { $post: any }
      • $post:function
        • $post(param: { code: string; redirect-url: string; state: string }): Promise<accessOpenidLoginLogin>

        • Verify OpenID authorization code and create a ticket. POST /access/openid/login

          Allowtoken

          1

          Permissions

          Parameters

          • param: { code: string; redirect-url: string; state: string }
            • code: string
            • redirect-url: string
            • state: string

          Returns Promise<accessOpenidLoginLogin>

    • $get:function
  • password: { $put: any }
    • $put:function
      • $put(param: { password: string; userid: string }): Promise<null>

      • Change user password. PUT /access/password

        Allowtoken

        0

        Permissions

        Parameters

        • param: { password: string; userid: string }
          • password: string
          • userid: string

        Returns Promise<null>

  • permissions: { $get: any }
    • $get:function
      • $get(param?: { path?: string; userid?: string }): Promise<any>

      • Retrieve effective permissions of given user/token. GET /access/permissions

        Allowtoken

        1

        Permissions

        Parameters

        • Optional param: { path?: string; userid?: string }
          • Optional path?: string
          • Optional userid?: string

        Returns Promise<any>

  • roles: { $: any; $get: any; $post: any }
    • $:function
      • $(roleid: string): { $delete: any; $get: any; $put: any }

      • Parameters

        • roleid: string

        Returns { $delete: any; $get: any; $put: any }

        • $delete:function
          • $delete(): Promise<null>

          • Delete role. DELETE /access/roles/{roleid}

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
        • $put:function
          • $put(param?: { append?: boolean; privs?: string }): Promise<null>

          • Update an existing role. PUT /access/roles/{roleid}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { append?: boolean; privs?: string }
              • Optional append?: boolean
              • Optional privs?: string

            Returns Promise<null>

    • $get:function
    • $post:function
      • $post(param: { privs?: string; roleid: string }): Promise<null>

      • Create new role. POST /access/roles

        Allowtoken

        1

        Permissions

        Parameters

        • param: { privs?: string; roleid: string }
          • Optional privs?: string
          • roleid: string

        Returns Promise<null>

  • tfa: { $: any; $get: any; $post: any }
    • $:function
      • $(userid: string): { $: any; $get: any; $post: any }

      • Parameters

        • userid: string

        Returns { $: any; $get: any; $post: any }

        • $:function
          • $(id: string): { $delete: any; $get: any; $put: any }

          • Parameters

            • id: string

            Returns { $delete: any; $get: any; $put: any }

            • $delete:function
              • $delete(param?: { password?: string }): Promise<null>

              • Delete a TFA entry by ID. DELETE /access/tfa/{userid}/{id}

                Allowtoken

                0

                Permissions

                Parameters

                • Optional param: { password?: string }
                  • Optional password?: string

                Returns Promise<null>

            • $get:function
            • $put:function
              • $put(param?: { description?: string; enable?: boolean; password?: string }): Promise<null>

              • Add a TFA entry for a user. PUT /access/tfa/{userid}/{id}

                Allowtoken

                0

                Permissions

                Parameters

                • Optional param: { description?: string; enable?: boolean; password?: string }
                  • Optional description?: string
                  • Optional enable?: boolean
                  • Optional password?: string

                Returns Promise<null>

        • $get:function
        • $post:function
          • $post(param: { challenge?: string; description?: string; password?: string; totp?: string; type: Ttype_20; value?: string }): Promise<accessTfaAddTfaEntry>

          • Add a TFA entry for a user. POST /access/tfa/{userid}

            Allowtoken

            0

            Permissions

            Parameters

            • param: { challenge?: string; description?: string; password?: string; totp?: string; type: Ttype_20; value?: string }
              • Optional challenge?: string
              • Optional description?: string
              • Optional password?: string
              • Optional totp?: string
              • type: Ttype_20
              • Optional value?: string

            Returns Promise<accessTfaAddTfaEntry>

    • $get:function
    • $post:function
  • ticket: { $get: any; $post: any }
    • $get:function
      • $get(): Promise<null>

      • Dummy. Useful for formatters which want to provide a login page. GET /access/ticket

        Allowtoken

        1

        Permissions

        Returns Promise<null>

    • $post:function
      • $post(param: { new-format?: boolean; otp?: string; password: string; path?: string; privs?: string; realm?: string; tfa-challenge?: string; username: string }): Promise<accessTicketCreateTicket>

      • Create or verify authentication ticket. POST /access/ticket

        Allowtoken

        0

        Permissions

        Parameters

        • param: { new-format?: boolean; otp?: string; password: string; path?: string; privs?: string; realm?: string; tfa-challenge?: string; username: string }
          • Optional new-format?: boolean
          • Optional otp?: string
          • password: string
          • Optional path?: string
          • Optional privs?: string
          • Optional realm?: string
          • Optional tfa-challenge?: string
          • username: string

        Returns Promise<accessTicketCreateTicket>

  • users: { $: any; $get: any; $post: any }
    • $:function
      • $(userid: string): { tfa: { $get: any }; token: { $: any; $get: any }; $delete: any; $get: any; $put: any }

      • Parameters

        • userid: string

        Returns { tfa: { $get: any }; token: { $: any; $get: any }; $delete: any; $get: any; $put: any }

        • tfa: { $get: any }
        • token: { $: any; $get: any }
          • $:function
            • $(tokenid: string): { $delete: any; $get: any; $post: any; $put: any }

            • Parameters

              • tokenid: string

              Returns { $delete: any; $get: any; $post: any; $put: any }

              • $delete:function
                • $delete(): Promise<null>

                • Remove API token for a specific user. DELETE /access/users/{userid}/token/{tokenid}

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<null>

              • $get:function
              • $post:function
                • $post(param?: { comment?: string; expire?: number; privsep?: boolean }): Promise<accessUsersTokenGenerateToken>

                • Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards! POST /access/users/{userid}/token/{tokenid}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { comment?: string; expire?: number; privsep?: boolean }
                    • Optional comment?: string
                    • Optional expire?: number
                    • Optional privsep?: boolean

                  Returns Promise<accessUsersTokenGenerateToken>

              • $put:function
                • $put(param?: { comment?: string; expire?: number; privsep?: boolean }): Promise<accessUsersTokenUpdateTokenInfo>

                • Update API token for a specific user. PUT /access/users/{userid}/token/{tokenid}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { comment?: string; expire?: number; privsep?: boolean }
                    • Optional comment?: string
                    • Optional expire?: number
                    • Optional privsep?: boolean

                  Returns Promise<accessUsersTokenUpdateTokenInfo>

          • $get:function
        • $delete:function
          • $delete(): Promise<null>

          • Delete user. DELETE /access/users/{userid}

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
        • $put:function
          • $put(param?: { append?: boolean; comment?: string; email?: string; enable?: boolean; expire?: number; firstname?: string; groups?: string; keys?: string; lastname?: string }): Promise<null>

          • Update user configuration. PUT /access/users/{userid}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { append?: boolean; comment?: string; email?: string; enable?: boolean; expire?: number; firstname?: string; groups?: string; keys?: string; lastname?: string }
              • Optional append?: boolean
              • Optional comment?: string
              • Optional email?: string
              • Optional enable?: boolean
              • Optional expire?: number
              • Optional firstname?: string
              • Optional groups?: string
              • Optional keys?: string
              • Optional lastname?: string

            Returns Promise<null>

    • $get:function
      • $get(param?: { enabled?: boolean; full?: boolean }): Promise<accessUsersIndex[]>

      • User index. GET /access/users

        Allowtoken

        1

        Permissions

        Parameters

        • Optional param: { enabled?: boolean; full?: boolean }
          • Optional enabled?: boolean
          • Optional full?: boolean

        Returns Promise<accessUsersIndex[]>

    • $post:function
      • $post(param: { comment?: string; email?: string; enable?: boolean; expire?: number; firstname?: string; groups?: string; keys?: string; lastname?: string; password?: string; userid: string }): Promise<null>

      • Create new user. POST /access/users

        Allowtoken

        1

        Permissions

        Parameters

        • param: { comment?: string; email?: string; enable?: boolean; expire?: number; firstname?: string; groups?: string; keys?: string; lastname?: string; password?: string; userid: string }
          • Optional comment?: string
          • Optional email?: string
          • Optional enable?: boolean
          • Optional expire?: number
          • Optional firstname?: string
          • Optional groups?: string
          • Optional keys?: string
          • Optional lastname?: string
          • Optional password?: string
          • userid: string

        Returns Promise<null>

  • $get:function

cluster

cluster: { acme: { account: { $: any; $get: any; $post: any }; challenge-schema: { $get: any }; directories: { $get: any }; plugins: { $: any; $get: any; $post: any }; tos: { $get: any }; $get: any }; backup: { $: any; $get: any; $post: any }; backup-info: { not-backed-up: { $get: any }; $get: any }; ceph: { flags: { $: any; $get: any; $put: any }; metadata: { $get: any }; status: { $get: any }; $get: any }; config: { apiversion: { $get: any }; join: { $get: any; $post: any }; nodes: { $: any; $get: any }; qdevice: { $get: any }; totem: { $get: any }; $get: any; $post: any }; firewall: { aliases: { $: any; $get: any; $post: any }; groups: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; macros: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }; ha: { groups: { $: any; $get: any; $post: any }; resources: { $: any; $get: any; $post: any }; status: { current: { $get: any }; manager_status: { $get: any }; $get: any }; $get: any }; jobs: { schedule-analyze: { $get: any }; $get: any }; log: { $get: any }; metrics: { server: { $: any; $get: any }; $get: any }; nextid: { $get: any }; options: { $get: any; $put: any }; replication: { $: any; $get: any; $post: any }; resources: { $get: any }; sdn: { controllers: { $: any; $get: any; $post: any }; dns: { $: any; $get: any; $post: any }; ipams: { $: any; $get: any; $post: any }; vnets: { $: any; $get: any; $post: any }; zones: { $: any; $get: any; $post: any }; $get: any; $put: any }; status: { $get: any }; tasks: { $get: any }; $get: any }

Type declaration

  • acme: { account: { $: any; $get: any; $post: any }; challenge-schema: { $get: any }; directories: { $get: any }; plugins: { $: any; $get: any; $post: any }; tos: { $get: any }; $get: any }
    • account: { $: any; $get: any; $post: any }
      • $:function
        • $(name: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • name: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<string>

            • Deactivate existing ACME account at CA. DELETE /cluster/acme/account/{name}

              Allowtoken

              1

              Returns Promise<string>

          • $get:function
          • $put:function
            • $put(param?: { contact?: string }): Promise<string>

            • Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh. PUT /cluster/acme/account/{name}

              Allowtoken

              1

              Parameters

              • Optional param: { contact?: string }
                • Optional contact?: string

              Returns Promise<string>

      • $get:function
      • $post:function
        • $post(param: { contact: string; directory?: string; name?: string; tos_url?: string }): Promise<string>

        • Register a new ACME account with CA. POST /cluster/acme/account

          Allowtoken

          1

          Parameters

          • param: { contact: string; directory?: string; name?: string; tos_url?: string }
            • contact: string
            • Optional directory?: string
            • Optional name?: string
            • Optional tos_url?: string

          Returns Promise<string>

    • challenge-schema: { $get: any }
    • directories: { $get: any }
    • plugins: { $: any; $get: any; $post: any }
      • $:function
        • $(id: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • id: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Delete ACME plugin configuration. DELETE /cluster/acme/plugins/{id}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(): Promise<any>

            • Get ACME plugin configuration. GET /cluster/acme/plugins/{id}

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $put:function
            • $put(param?: { api?: Tapi; data?: string; delete?: string; digest?: string; disable?: boolean; nodes?: string; validation-delay?: number }): Promise<null>

            • Update ACME plugin configuration. PUT /cluster/acme/plugins/{id}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { api?: Tapi; data?: string; delete?: string; digest?: string; disable?: boolean; nodes?: string; validation-delay?: number }
                • Optional api?: Tapi
                • Optional data?: string
                • Optional delete?: string
                • Optional digest?: string
                • Optional disable?: boolean
                • Optional nodes?: string
                • Optional validation-delay?: number

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { api?: Tapi; data?: string; disable?: boolean; id: string; nodes?: string; type: Ttype_5; validation-delay?: number }): Promise<null>

        • Add ACME plugin configuration. POST /cluster/acme/plugins

          Allowtoken

          1

          Permissions

          Parameters

          • param: { api?: Tapi; data?: string; disable?: boolean; id: string; nodes?: string; type: Ttype_5; validation-delay?: number }
            • Optional api?: Tapi
            • Optional data?: string
            • Optional disable?: boolean
            • id: string
            • Optional nodes?: string
            • type: Ttype_5
            • Optional validation-delay?: number

          Returns Promise<null>

    • tos: { $get: any }
      • $get:function
        • $get(param?: { directory?: string }): Promise<string>

        • Retrieve ACME TermsOfService URL from CA. GET /cluster/acme/tos

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { directory?: string }
            • Optional directory?: string

          Returns Promise<string>

    • $get:function
  • backup: { $: any; $get: any; $post: any }
    • $:function
      • $(id: string): { included_volumes: { $get: any }; $delete: any; $get: any; $put: any }

      • Parameters

        • id: string

        Returns { included_volumes: { $get: any }; $delete: any; $get: any; $put: any }

        • included_volumes: { $get: any }
        • $delete:function
          • $delete(): Promise<null>

          • Delete vzdump backup job definition. DELETE /cluster/backup/{id}

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
          • $get(): Promise<any>

          • Read vzdump backup job definition. GET /cluster/backup/{id}

            Allowtoken

            1

            Permissions

            Returns Promise<any>

        • $put:function
          • $put(param?: { all?: boolean; bwlimit?: number; comment?: string; compress?: Tcompress; delete?: string; dow?: string; dumpdir?: string; enabled?: boolean; exclude?: string; exclude-path?: string; ionice?: number; lockwait?: number; mailnotification?: Tmailnotification; mailto?: string; maxfiles?: number; mode?: Tmode; node?: string; pigz?: number; pool?: string; prune-backups?: string; quiet?: boolean; remove?: boolean; schedule?: string; script?: string; starttime?: string; stdexcludes?: boolean; stop?: boolean; stopwait?: number; storage?: string; tmpdir?: string; vmid?: string; zstd?: number }): Promise<null>

          • Update vzdump backup job definition. PUT /cluster/backup/{id}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { all?: boolean; bwlimit?: number; comment?: string; compress?: Tcompress; delete?: string; dow?: string; dumpdir?: string; enabled?: boolean; exclude?: string; exclude-path?: string; ionice?: number; lockwait?: number; mailnotification?: Tmailnotification; mailto?: string; maxfiles?: number; mode?: Tmode; node?: string; pigz?: number; pool?: string; prune-backups?: string; quiet?: boolean; remove?: boolean; schedule?: string; script?: string; starttime?: string; stdexcludes?: boolean; stop?: boolean; stopwait?: number; storage?: string; tmpdir?: string; vmid?: string; zstd?: number }
              • Optional all?: boolean
              • Optional bwlimit?: number
              • Optional comment?: string
              • Optional compress?: Tcompress
              • Optional delete?: string
              • Optional dow?: string
              • Optional dumpdir?: string
              • Optional enabled?: boolean
              • Optional exclude?: string
              • Optional exclude-path?: string
              • Optional ionice?: number
              • Optional lockwait?: number
              • Optional mailnotification?: Tmailnotification
              • Optional mailto?: string
              • Optional maxfiles?: number
              • Optional mode?: Tmode
              • Optional node?: string
              • Optional pigz?: number
              • Optional pool?: string
              • Optional prune-backups?: string
              • Optional quiet?: boolean
              • Optional remove?: boolean
              • Optional schedule?: string
              • Optional script?: string
              • Optional starttime?: string
              • Optional stdexcludes?: boolean
              • Optional stop?: boolean
              • Optional stopwait?: number
              • Optional storage?: string
              • Optional tmpdir?: string
              • Optional vmid?: string
              • Optional zstd?: number

            Returns Promise<null>

    • $get:function
    • $post:function
      • $post(param?: { all?: boolean; bwlimit?: number; comment?: string; compress?: Tcompress; dow?: string; dumpdir?: string; enabled?: boolean; exclude?: string; exclude-path?: string; id?: string; ionice?: number; lockwait?: number; mailnotification?: Tmailnotification; mailto?: string; maxfiles?: number; mode?: Tmode; node?: string; pigz?: number; pool?: string; prune-backups?: string; quiet?: boolean; remove?: boolean; schedule?: string; script?: string; starttime?: string; stdexcludes?: boolean; stop?: boolean; stopwait?: number; storage?: string; tmpdir?: string; vmid?: string; zstd?: number }): Promise<null>

      • Create new vzdump backup job. POST /cluster/backup

        Allowtoken

        1

        Permissions

        Parameters

        • Optional param: { all?: boolean; bwlimit?: number; comment?: string; compress?: Tcompress; dow?: string; dumpdir?: string; enabled?: boolean; exclude?: string; exclude-path?: string; id?: string; ionice?: number; lockwait?: number; mailnotification?: Tmailnotification; mailto?: string; maxfiles?: number; mode?: Tmode; node?: string; pigz?: number; pool?: string; prune-backups?: string; quiet?: boolean; remove?: boolean; schedule?: string; script?: string; starttime?: string; stdexcludes?: boolean; stop?: boolean; stopwait?: number; storage?: string; tmpdir?: string; vmid?: string; zstd?: number }
          • Optional all?: boolean
          • Optional bwlimit?: number
          • Optional comment?: string
          • Optional compress?: Tcompress
          • Optional dow?: string
          • Optional dumpdir?: string
          • Optional enabled?: boolean
          • Optional exclude?: string
          • Optional exclude-path?: string
          • Optional id?: string
          • Optional ionice?: number
          • Optional lockwait?: number
          • Optional mailnotification?: Tmailnotification
          • Optional mailto?: string
          • Optional maxfiles?: number
          • Optional mode?: Tmode
          • Optional node?: string
          • Optional pigz?: number
          • Optional pool?: string
          • Optional prune-backups?: string
          • Optional quiet?: boolean
          • Optional remove?: boolean
          • Optional schedule?: string
          • Optional script?: string
          • Optional starttime?: string
          • Optional stdexcludes?: boolean
          • Optional stop?: boolean
          • Optional stopwait?: number
          • Optional storage?: string
          • Optional tmpdir?: string
          • Optional vmid?: string
          • Optional zstd?: number

        Returns Promise<null>

  • backup-info: { not-backed-up: { $get: any }; $get: any }
  • ceph: { flags: { $: any; $get: any; $put: any }; metadata: { $get: any }; status: { $get: any }; $get: any }
    • flags: { $: any; $get: any; $put: any }
      • $:function
        • $(flag: string): { $get: any; $put: any }

        • Parameters

          • flag: string

          Returns { $get: any; $put: any }

          • $get:function
            • $get(): Promise<boolean>

            • Get the status of a specific ceph flag. GET /cluster/ceph/flags/{flag}

              Allowtoken

              1

              Permissions

              Returns Promise<boolean>

          • $put:function
            • $put(param: { value: boolean }): Promise<null>

            • Set or clear (unset) a specific ceph flag PUT /cluster/ceph/flags/{flag}

              Allowtoken

              1

              Permissions

              Parameters

              • param: { value: boolean }
                • value: boolean

              Returns Promise<null>

      • $get:function
      • $put:function
        • $put(param?: { nobackfill?: boolean; nodeep-scrub?: boolean; nodown?: boolean; noin?: boolean; noout?: boolean; norebalance?: boolean; norecover?: boolean; noscrub?: boolean; notieragent?: boolean; noup?: boolean; pause?: boolean }): Promise<string>

        • Set/Unset multiple ceph flags at once. PUT /cluster/ceph/flags

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { nobackfill?: boolean; nodeep-scrub?: boolean; nodown?: boolean; noin?: boolean; noout?: boolean; norebalance?: boolean; norecover?: boolean; noscrub?: boolean; notieragent?: boolean; noup?: boolean; pause?: boolean }
            • Optional nobackfill?: boolean
            • Optional nodeep-scrub?: boolean
            • Optional nodown?: boolean
            • Optional noin?: boolean
            • Optional noout?: boolean
            • Optional norebalance?: boolean
            • Optional norecover?: boolean
            • Optional noscrub?: boolean
            • Optional notieragent?: boolean
            • Optional noup?: boolean
            • Optional pause?: boolean

          Returns Promise<string>

    • metadata: { $get: any }
      • $get:function
        • $get(param?: { scope?: Tscope }): Promise<any>

        • Get ceph metadata. GET /cluster/ceph/metadata

          Allowtoken

          1

          Permissions

          Parameters

          Returns Promise<any>

    • status: { $get: any }
      • $get:function
        • $get(): Promise<any>

        • Get ceph status. GET /cluster/ceph/status

          Allowtoken

          1

          Permissions

          Returns Promise<any>

    • $get:function
  • config: { apiversion: { $get: any }; join: { $get: any; $post: any }; nodes: { $: any; $get: any }; qdevice: { $get: any }; totem: { $get: any }; $get: any; $post: any }
    • apiversion: { $get: any }
      • $get:function
        • $get(): Promise<number>

        • Return the version of the cluster join API available on this node. GET /cluster/config/apiversion

          Allowtoken

          1

          Permissions

          Returns Promise<number>

    • join: { $get: any; $post: any }
      • $get:function
        • $get(param?: { node?: string }): Promise<clusterConfigJoinJoinInfo>

        • Get information needed to join this cluster over the connected node. GET /cluster/config/join

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { node?: string }
            • Optional node?: string

          Returns Promise<clusterConfigJoinJoinInfo>

      • $post:function
        • $post(param: { fingerprint: string; force?: boolean; hostname: string; link0?: string; link1?: string; link2?: string; link3?: string; link4?: string; link5?: string; link6?: string; link7?: string; nodeid?: number; password: string; votes?: number }): Promise<string>

        • Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links). POST /cluster/config/join

          Allowtoken

          1

          Parameters

          • param: { fingerprint: string; force?: boolean; hostname: string; link0?: string; link1?: string; link2?: string; link3?: string; link4?: string; link5?: string; link6?: string; link7?: string; nodeid?: number; password: string; votes?: number }
            • fingerprint: string
            • Optional force?: boolean
            • hostname: string
            • Optional link0?: string
            • Optional link1?: string
            • Optional link2?: string
            • Optional link3?: string
            • Optional link4?: string
            • Optional link5?: string
            • Optional link6?: string
            • Optional link7?: string
            • Optional nodeid?: number
            • password: string
            • Optional votes?: number

          Returns Promise<string>

    • nodes: { $: any; $get: any }
      • $:function
        • $(node: string): { $delete: any; $post: any }

        • Parameters

          • node: string

          Returns { $delete: any; $post: any }

          • $delete:function
            • $delete(): Promise<null>

            • Removes a node from the cluster configuration. DELETE /cluster/config/nodes/{node}

              Allowtoken

              1

              Returns Promise<null>

          • $post:function
            • $post(param?: { apiversion?: number; force?: boolean; link0?: string; link1?: string; link2?: string; link3?: string; link4?: string; link5?: string; link6?: string; link7?: string; new_node_ip?: string; nodeid?: number; votes?: number }): Promise<clusterConfigNodesAddnode>

            • Adds a node to the cluster configuration. This call is for internal use. POST /cluster/config/nodes/{node}

              Allowtoken

              1

              Parameters

              • Optional param: { apiversion?: number; force?: boolean; link0?: string; link1?: string; link2?: string; link3?: string; link4?: string; link5?: string; link6?: string; link7?: string; new_node_ip?: string; nodeid?: number; votes?: number }
                • Optional apiversion?: number
                • Optional force?: boolean
                • Optional link0?: string
                • Optional link1?: string
                • Optional link2?: string
                • Optional link3?: string
                • Optional link4?: string
                • Optional link5?: string
                • Optional link6?: string
                • Optional link7?: string
                • Optional new_node_ip?: string
                • Optional nodeid?: number
                • Optional votes?: number

              Returns Promise<clusterConfigNodesAddnode>

      • $get:function
    • qdevice: { $get: any }
      • $get:function
        • $get(): Promise<any>

        • Get QDevice status GET /cluster/config/qdevice

          Allowtoken

          1

          Permissions

          Returns Promise<any>

    • totem: { $get: any }
      • $get:function
        • $get(): Promise<any>

        • Get corosync totem protocol settings. GET /cluster/config/totem

          Allowtoken

          1

          Permissions

          Returns Promise<any>

    • $get:function
    • $post:function
      • $post(param: { clustername: string; link0?: string; link1?: string; link2?: string; link3?: string; link4?: string; link5?: string; link6?: string; link7?: string; nodeid?: number; votes?: number }): Promise<string>

      • Generate new cluster configuration. If no links given, default to local IP address as link0. POST /cluster/config

        Allowtoken

        1

        Parameters

        • param: { clustername: string; link0?: string; link1?: string; link2?: string; link3?: string; link4?: string; link5?: string; link6?: string; link7?: string; nodeid?: number; votes?: number }
          • clustername: string
          • Optional link0?: string
          • Optional link1?: string
          • Optional link2?: string
          • Optional link3?: string
          • Optional link4?: string
          • Optional link5?: string
          • Optional link6?: string
          • Optional link7?: string
          • Optional nodeid?: number
          • Optional votes?: number

        Returns Promise<string>

  • firewall: { aliases: { $: any; $get: any; $post: any }; groups: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; macros: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }
    • aliases: { $: any; $get: any; $post: any }
      • $:function
        • $(name: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • name: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(param?: { digest?: string }): Promise<null>

            • Remove IP or Network alias. DELETE /cluster/firewall/aliases/{name}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { digest?: string }
                • Optional digest?: string

              Returns Promise<null>

          • $get:function
            • $get(): Promise<any>

            • Read alias. GET /cluster/firewall/aliases/{name}

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $put:function
            • $put(param: { cidr: string; comment?: string; digest?: string; rename?: string }): Promise<null>

            • Update IP or Network alias. PUT /cluster/firewall/aliases/{name}

              Allowtoken

              1

              Permissions

              Parameters

              • param: { cidr: string; comment?: string; digest?: string; rename?: string }
                • cidr: string
                • Optional comment?: string
                • Optional digest?: string
                • Optional rename?: string

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { cidr: string; comment?: string; name: string }): Promise<null>

        • Create IP or Network Alias. POST /cluster/firewall/aliases

          Allowtoken

          1

          Permissions

          Parameters

          • param: { cidr: string; comment?: string; name: string }
            • cidr: string
            • Optional comment?: string
            • name: string

          Returns Promise<null>

    • groups: { $: any; $get: any; $post: any }
      • $:function
        • $(group: string): { $: any; $delete: any; $get: any; $post: any }

        • Parameters

          • group: string

          Returns { $: any; $delete: any; $get: any; $post: any }

          • $:function
            • $(pos: string): { $delete: any; $get: any; $put: any }

            • Parameters

              • pos: string

              Returns { $delete: any; $get: any; $put: any }

              • $delete:function
                • $delete(param?: { digest?: string }): Promise<null>

                • Delete rule. DELETE /cluster/firewall/groups/{group}/{pos}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { digest?: string }
                    • Optional digest?: string

                  Returns Promise<null>

              • $get:function
              • $put:function
                • $put(param?: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }): Promise<null>

                • Modify rule data. PUT /cluster/firewall/groups/{group}/{pos}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }
                    • Optional action?: string
                    • Optional comment?: string
                    • Optional delete?: string
                    • Optional dest?: string
                    • Optional digest?: string
                    • Optional dport?: string
                    • Optional enable?: number
                    • Optional icmp-type?: string
                    • Optional iface?: string
                    • Optional log?: Tlog
                    • Optional macro?: string
                    • Optional moveto?: number
                    • Optional proto?: string
                    • Optional source?: string
                    • Optional sport?: string
                    • Optional type?: Ttype_1

                  Returns Promise<null>

          • $delete:function
            • $delete(): Promise<null>

            • Delete security group. DELETE /cluster/firewall/groups/{group}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
          • $post:function
            • $post(param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }): Promise<null>

            • Create new rule. POST /cluster/firewall/groups/{group}

              Allowtoken

              1

              Permissions

              Parameters

              • param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }
                • action: string
                • Optional comment?: string
                • Optional dest?: string
                • Optional digest?: string
                • Optional dport?: string
                • Optional enable?: number
                • Optional icmp-type?: string
                • Optional iface?: string
                • Optional log?: Tlog
                • Optional macro?: string
                • Optional pos?: number
                • Optional proto?: string
                • Optional source?: string
                • Optional sport?: string
                • type: Ttype_1

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { comment?: string; digest?: string; group: string; rename?: string }): Promise<null>

        • Create new security group. POST /cluster/firewall/groups

          Allowtoken

          1

          Permissions

          Parameters

          • param: { comment?: string; digest?: string; group: string; rename?: string }
            • Optional comment?: string
            • Optional digest?: string
            • group: string
            • Optional rename?: string

          Returns Promise<null>

    • ipset: { $: any; $get: any; $post: any }
      • $:function
        • $(name: string): { $: any; $delete: any; $get: any; $post: any }

        • Parameters

          • name: string

          Returns { $: any; $delete: any; $get: any; $post: any }

          • $:function
            • $(cidr: string): { $delete: any; $get: any; $put: any }

            • Parameters

              • cidr: string

              Returns { $delete: any; $get: any; $put: any }

              • $delete:function
                • $delete(param?: { digest?: string }): Promise<null>

                • Remove IP or Network from IPSet. DELETE /cluster/firewall/ipset/{name}/{cidr}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { digest?: string }
                    • Optional digest?: string

                  Returns Promise<null>

              • $get:function
                • $get(): Promise<any>

                • Read IP or Network settings from IPSet. GET /cluster/firewall/ipset/{name}/{cidr}

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<any>

              • $put:function
                • $put(param?: { comment?: string; digest?: string; nomatch?: boolean }): Promise<null>

                • Update IP or Network settings PUT /cluster/firewall/ipset/{name}/{cidr}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { comment?: string; digest?: string; nomatch?: boolean }
                    • Optional comment?: string
                    • Optional digest?: string
                    • Optional nomatch?: boolean

                  Returns Promise<null>

          • $delete:function
            • $delete(): Promise<null>

            • Delete IPSet DELETE /cluster/firewall/ipset/{name}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
          • $post:function
            • $post(param: { cidr: string; comment?: string; nomatch?: boolean }): Promise<null>

            • Add IP or Network to IPSet. POST /cluster/firewall/ipset/{name}

              Allowtoken

              1

              Permissions

              Parameters

              • param: { cidr: string; comment?: string; nomatch?: boolean }
                • cidr: string
                • Optional comment?: string
                • Optional nomatch?: boolean

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { comment?: string; digest?: string; name: string; rename?: string }): Promise<null>

        • Create new IPSet POST /cluster/firewall/ipset

          Allowtoken

          1

          Permissions

          Parameters

          • param: { comment?: string; digest?: string; name: string; rename?: string }
            • Optional comment?: string
            • Optional digest?: string
            • name: string
            • Optional rename?: string

          Returns Promise<null>

    • macros: { $get: any }
    • options: { $get: any; $put: any }
      • $get:function
      • $put:function
        • $put(param?: { delete?: string; digest?: string; ebtables?: boolean; enable?: number; log_ratelimit?: string; policy_in?: Tpolicy_in; policy_out?: Tpolicy_in }): Promise<null>

        • Set Firewall options. PUT /cluster/firewall/options

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { delete?: string; digest?: string; ebtables?: boolean; enable?: number; log_ratelimit?: string; policy_in?: Tpolicy_in; policy_out?: Tpolicy_in }
            • Optional delete?: string
            • Optional digest?: string
            • Optional ebtables?: boolean
            • Optional enable?: number
            • Optional log_ratelimit?: string
            • Optional policy_in?: Tpolicy_in
            • Optional policy_out?: Tpolicy_in

          Returns Promise<null>

    • refs: { $get: any }
    • rules: { $: any; $get: any; $post: any }
      • $:function
        • $(pos: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • pos: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(param?: { digest?: string }): Promise<null>

            • Delete rule. DELETE /cluster/firewall/rules/{pos}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { digest?: string }
                • Optional digest?: string

              Returns Promise<null>

          • $get:function
          • $put:function
            • $put(param?: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }): Promise<null>

            • Modify rule data. PUT /cluster/firewall/rules/{pos}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }
                • Optional action?: string
                • Optional comment?: string
                • Optional delete?: string
                • Optional dest?: string
                • Optional digest?: string
                • Optional dport?: string
                • Optional enable?: number
                • Optional icmp-type?: string
                • Optional iface?: string
                • Optional log?: Tlog
                • Optional macro?: string
                • Optional moveto?: number
                • Optional proto?: string
                • Optional source?: string
                • Optional sport?: string
                • Optional type?: Ttype_1

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }): Promise<null>

        • Create new rule. POST /cluster/firewall/rules

          Allowtoken

          1

          Permissions

          Parameters

          • param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }
            • action: string
            • Optional comment?: string
            • Optional dest?: string
            • Optional digest?: string
            • Optional dport?: string
            • Optional enable?: number
            • Optional icmp-type?: string
            • Optional iface?: string
            • Optional log?: Tlog
            • Optional macro?: string
            • Optional pos?: number
            • Optional proto?: string
            • Optional source?: string
            • Optional sport?: string
            • type: Ttype_1

          Returns Promise<null>

    • $get:function
  • ha: { groups: { $: any; $get: any; $post: any }; resources: { $: any; $get: any; $post: any }; status: { current: { $get: any }; manager_status: { $get: any }; $get: any }; $get: any }
    • groups: { $: any; $get: any; $post: any }
      • $:function
        • $(group: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • group: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Delete ha group configuration. DELETE /cluster/ha/groups/{group}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(): Promise<any>

            • Read ha group configuration. GET /cluster/ha/groups/{group}

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $put:function
            • $put(param?: { comment?: string; delete?: string; digest?: string; nodes?: string; nofailback?: boolean; restricted?: boolean }): Promise<null>

            • Update ha group configuration. PUT /cluster/ha/groups/{group}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { comment?: string; delete?: string; digest?: string; nodes?: string; nofailback?: boolean; restricted?: boolean }
                • Optional comment?: string
                • Optional delete?: string
                • Optional digest?: string
                • Optional nodes?: string
                • Optional nofailback?: boolean
                • Optional restricted?: boolean

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { comment?: string; group: string; nodes: string; nofailback?: boolean; restricted?: boolean; type?: "group" }): Promise<null>

        • Create a new HA group. POST /cluster/ha/groups

          Allowtoken

          1

          Permissions

          Parameters

          • param: { comment?: string; group: string; nodes: string; nofailback?: boolean; restricted?: boolean; type?: "group" }
            • Optional comment?: string
            • group: string
            • nodes: string
            • Optional nofailback?: boolean
            • Optional restricted?: boolean
            • Optional type?: "group"

          Returns Promise<null>

    • resources: { $: any; $get: any; $post: any }
      • $:function
        • $(sid: string): { migrate: { $post: any }; relocate: { $post: any }; $delete: any; $get: any; $put: any }

        • Parameters

          • sid: string

          Returns { migrate: { $post: any }; relocate: { $post: any }; $delete: any; $get: any; $put: any }

          • migrate: { $post: any }
            • $post:function
              • $post(param: { node: string }): Promise<null>

              • Request resource migration (online) to another node. POST /cluster/ha/resources/{sid}/migrate

                Allowtoken

                1

                Permissions

                Parameters

                • param: { node: string }
                  • node: string

                Returns Promise<null>

          • relocate: { $post: any }
            • $post:function
              • $post(param: { node: string }): Promise<null>

              • Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node. POST /cluster/ha/resources/{sid}/relocate

                Allowtoken

                1

                Permissions

                Parameters

                • param: { node: string }
                  • node: string

                Returns Promise<null>

          • $delete:function
            • $delete(): Promise<null>

            • Delete resource configuration. DELETE /cluster/ha/resources/{sid}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
          • $put:function
            • $put(param?: { comment?: string; delete?: string; digest?: string; group?: string; max_relocate?: number; max_restart?: number; state?: Tstate }): Promise<null>

            • Update resource configuration. PUT /cluster/ha/resources/{sid}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { comment?: string; delete?: string; digest?: string; group?: string; max_relocate?: number; max_restart?: number; state?: Tstate }
                • Optional comment?: string
                • Optional delete?: string
                • Optional digest?: string
                • Optional group?: string
                • Optional max_relocate?: number
                • Optional max_restart?: number
                • Optional state?: Tstate

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { comment?: string; group?: string; max_relocate?: number; max_restart?: number; sid: string; state?: Tstate; type?: Ttype_3 }): Promise<null>

        • Create a new HA resource. POST /cluster/ha/resources

          Allowtoken

          1

          Permissions

          Parameters

          • param: { comment?: string; group?: string; max_relocate?: number; max_restart?: number; sid: string; state?: Tstate; type?: Ttype_3 }
            • Optional comment?: string
            • Optional group?: string
            • Optional max_relocate?: number
            • Optional max_restart?: number
            • sid: string
            • Optional state?: Tstate
            • Optional type?: Ttype_3

          Returns Promise<null>

    • status: { current: { $get: any }; manager_status: { $get: any }; $get: any }
      • current: { $get: any }
        • $get:function
          • $get(): Promise<string[]>

          • Get HA manger status. GET /cluster/ha/status/current

            Allowtoken

            1

            Permissions

            Returns Promise<string[]>

      • manager_status: { $get: any }
        • $get:function
          • $get(): Promise<any>

          • Get full HA manger status, including LRM status. GET /cluster/ha/status/manager_status

            Allowtoken

            1

            Permissions

            Returns Promise<any>

      • $get:function
    • $get:function
  • jobs: { schedule-analyze: { $get: any }; $get: any }
    • schedule-analyze: { $get: any }
      • $get:function
    • $get:function
  • log: { $get: any }
    • $get:function
      • $get(param?: { max?: number }): Promise<clusterLogLog[]>

      • Read cluster log GET /cluster/log

        Allowtoken

        1

        Permissions

        Parameters

        • Optional param: { max?: number }
          • Optional max?: number

        Returns Promise<clusterLogLog[]>

  • metrics: { server: { $: any; $get: any }; $get: any }
    • server: { $: any; $get: any }
      • $:function
        • $(id: string): { $delete: any; $get: any; $post: any; $put: any }

        • Parameters

          • id: string

          Returns { $delete: any; $get: any; $post: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Remove Metric server. DELETE /cluster/metrics/server/{id}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(): Promise<any>

            • Read metric server configuration. GET /cluster/metrics/server/{id}

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $post:function
            • $post(param: { api-path-prefix?: string; bucket?: string; disable?: boolean; influxdbproto?: Tinfluxdbproto; max-body-size?: number; mtu?: number; organization?: string; path?: string; port: number; proto?: Tproto; server: string; timeout?: number; token?: string; type: pveconfigid; verify-certificate?: boolean }): Promise<null>

            • Create a new external metric server config POST /cluster/metrics/server/{id}

              Allowtoken

              1

              Permissions

              Parameters

              • param: { api-path-prefix?: string; bucket?: string; disable?: boolean; influxdbproto?: Tinfluxdbproto; max-body-size?: number; mtu?: number; organization?: string; path?: string; port: number; proto?: Tproto; server: string; timeout?: number; token?: string; type: pveconfigid; verify-certificate?: boolean }
                • Optional api-path-prefix?: string
                • Optional bucket?: string
                • Optional disable?: boolean
                • Optional influxdbproto?: Tinfluxdbproto
                • Optional max-body-size?: number
                • Optional mtu?: number
                • Optional organization?: string
                • Optional path?: string
                • port: number
                • Optional proto?: Tproto
                • server: string
                • Optional timeout?: number
                • Optional token?: string
                • type: pveconfigid
                • Optional verify-certificate?: boolean

              Returns Promise<null>

          • $put:function
            • $put(param: { api-path-prefix?: string; bucket?: string; delete?: string; digest?: string; disable?: boolean; influxdbproto?: Tinfluxdbproto; max-body-size?: number; mtu?: number; organization?: string; path?: string; port: number; proto?: Tproto; server: string; timeout?: number; token?: string; verify-certificate?: boolean }): Promise<null>

            • Update metric server configuration. PUT /cluster/metrics/server/{id}

              Allowtoken

              1

              Permissions

              Parameters

              • param: { api-path-prefix?: string; bucket?: string; delete?: string; digest?: string; disable?: boolean; influxdbproto?: Tinfluxdbproto; max-body-size?: number; mtu?: number; organization?: string; path?: string; port: number; proto?: Tproto; server: string; timeout?: number; token?: string; verify-certificate?: boolean }
                • Optional api-path-prefix?: string
                • Optional bucket?: string
                • Optional delete?: string
                • Optional digest?: string
                • Optional disable?: boolean
                • Optional influxdbproto?: Tinfluxdbproto
                • Optional max-body-size?: number
                • Optional mtu?: number
                • Optional organization?: string
                • Optional path?: string
                • port: number
                • Optional proto?: Tproto
                • server: string
                • Optional timeout?: number
                • Optional token?: string
                • Optional verify-certificate?: boolean

              Returns Promise<null>

      • $get:function
    • $get:function
  • nextid: { $get: any }
    • $get:function
      • $get(param?: { vmid?: number }): Promise<number>

      • Get next free VMID. If you pass an VMID it will raise an error if the ID is already used. GET /cluster/nextid

        Allowtoken

        1

        Permissions

        Parameters

        • Optional param: { vmid?: number }
          • Optional vmid?: number

        Returns Promise<number>

  • options: { $get: any; $put: any }
    • $get:function
      • $get(): Promise<any>

      • Get datacenter options. GET /cluster/options

        Allowtoken

        1

        Permissions

        Returns Promise<any>

    • $put:function
      • $put(param?: { bwlimit?: string; console?: Tconsole; delete?: string; description?: string; email_from?: string; fencing?: Tfencing; ha?: string; http_proxy?: string; keyboard?: Tkeyboard; language?: Tlanguage; mac_prefix?: string; max_workers?: number; migration?: string; migration_unsecure?: boolean; u2f?: string; webauthn?: string }): Promise<null>

      • Set datacenter options. PUT /cluster/options

        Allowtoken

        1

        Permissions

        Parameters

        • Optional param: { bwlimit?: string; console?: Tconsole; delete?: string; description?: string; email_from?: string; fencing?: Tfencing; ha?: string; http_proxy?: string; keyboard?: Tkeyboard; language?: Tlanguage; mac_prefix?: string; max_workers?: number; migration?: string; migration_unsecure?: boolean; u2f?: string; webauthn?: string }
          • Optional bwlimit?: string
          • Optional console?: Tconsole
          • Optional delete?: string
          • Optional description?: string
          • Optional email_from?: string
          • Optional fencing?: Tfencing
          • Optional ha?: string
          • Optional http_proxy?: string
          • Optional keyboard?: Tkeyboard
          • Optional language?: Tlanguage
          • Optional mac_prefix?: string
          • Optional max_workers?: number
          • Optional migration?: string
          • Optional migration_unsecure?: boolean
          • Optional u2f?: string
          • Optional webauthn?: string

        Returns Promise<null>

  • replication: { $: any; $get: any; $post: any }
    • $:function
      • $(id: string): { $delete: any; $get: any; $put: any }

      • Parameters

        • id: string

        Returns { $delete: any; $get: any; $put: any }

        • $delete:function
          • $delete(param?: { force?: boolean; keep?: boolean }): Promise<null>

          • Mark replication job for removal. DELETE /cluster/replication/{id}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { force?: boolean; keep?: boolean }
              • Optional force?: boolean
              • Optional keep?: boolean

            Returns Promise<null>

        • $get:function
          • $get(): Promise<any>

          • Read replication job configuration. GET /cluster/replication/{id}

            Allowtoken

            1

            Permissions

            Returns Promise<any>

        • $put:function
          • $put(param?: { comment?: string; delete?: string; digest?: string; disable?: boolean; rate?: number; remove_job?: Tremove_job; schedule?: string; source?: string }): Promise<null>

          • Update replication job configuration. PUT /cluster/replication/{id}

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { comment?: string; delete?: string; digest?: string; disable?: boolean; rate?: number; remove_job?: Tremove_job; schedule?: string; source?: string }
              • Optional comment?: string
              • Optional delete?: string
              • Optional digest?: string
              • Optional disable?: boolean
              • Optional rate?: number
              • Optional remove_job?: Tremove_job
              • Optional schedule?: string
              • Optional source?: string

            Returns Promise<null>

    • $get:function
    • $post:function
      • $post(param: { comment?: string; disable?: boolean; id: string; rate?: number; remove_job?: Tremove_job; schedule?: string; source?: string; target: string; type: "local" }): Promise<null>

      • Create a new replication job POST /cluster/replication

        Allowtoken

        1

        Permissions

        Parameters

        • param: { comment?: string; disable?: boolean; id: string; rate?: number; remove_job?: Tremove_job; schedule?: string; source?: string; target: string; type: "local" }
          • Optional comment?: string
          • Optional disable?: boolean
          • id: string
          • Optional rate?: number
          • Optional remove_job?: Tremove_job
          • Optional schedule?: string
          • Optional source?: string
          • target: string
          • type: "local"

        Returns Promise<null>

  • resources: { $get: any }
  • sdn: { controllers: { $: any; $get: any; $post: any }; dns: { $: any; $get: any; $post: any }; ipams: { $: any; $get: any; $post: any }; vnets: { $: any; $get: any; $post: any }; zones: { $: any; $get: any; $post: any }; $get: any; $put: any }
    • controllers: { $: any; $get: any; $post: any }
      • $:function
        • $(controller: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • controller: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Delete sdn controller object configuration. DELETE /cluster/sdn/controllers/{controller}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(param?: { pending?: boolean; running?: boolean }): Promise<any>

            • Read sdn controller configuration. GET /cluster/sdn/controllers/{controller}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { pending?: boolean; running?: boolean }
                • Optional pending?: boolean
                • Optional running?: boolean

              Returns Promise<any>

          • $put:function
            • $put(param?: { asn?: number; delete?: string; digest?: string; ebgp?: boolean; ebgp-multihop?: number; loopback?: string; node?: string; peers?: string }): Promise<null>

            • Update sdn controller object configuration. PUT /cluster/sdn/controllers/{controller}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { asn?: number; delete?: string; digest?: string; ebgp?: boolean; ebgp-multihop?: number; loopback?: string; node?: string; peers?: string }
                • Optional asn?: number
                • Optional delete?: string
                • Optional digest?: string
                • Optional ebgp?: boolean
                • Optional ebgp-multihop?: number
                • Optional loopback?: string
                • Optional node?: string
                • Optional peers?: string

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { asn?: number; controller: string; ebgp?: boolean; ebgp-multihop?: number; loopback?: string; node?: string; peers?: string; type: pveconfigid_3 }): Promise<null>

        • Create a new sdn controller object. POST /cluster/sdn/controllers

          Allowtoken

          1

          Permissions

          Parameters

          • param: { asn?: number; controller: string; ebgp?: boolean; ebgp-multihop?: number; loopback?: string; node?: string; peers?: string; type: pveconfigid_3 }
            • Optional asn?: number
            • controller: string
            • Optional ebgp?: boolean
            • Optional ebgp-multihop?: number
            • Optional loopback?: string
            • Optional node?: string
            • Optional peers?: string
            • type: pveconfigid_3

          Returns Promise<null>

    • dns: { $: any; $get: any; $post: any }
      • $:function
        • $(dns: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • dns: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Delete sdn dns object configuration. DELETE /cluster/sdn/dns/{dns}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(): Promise<any>

            • Read sdn dns configuration. GET /cluster/sdn/dns/{dns}

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $put:function
            • $put(param?: { delete?: string; digest?: string; key?: string; reversemaskv6?: number; ttl?: number; url?: string }): Promise<null>

            • Update sdn dns object configuration. PUT /cluster/sdn/dns/{dns}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { delete?: string; digest?: string; key?: string; reversemaskv6?: number; ttl?: number; url?: string }
                • Optional delete?: string
                • Optional digest?: string
                • Optional key?: string
                • Optional reversemaskv6?: number
                • Optional ttl?: number
                • Optional url?: string

              Returns Promise<null>

      • $get:function
        • $get(param?: { type?: "powerdns" }): Promise<clusterSdnDnsIndex[]>

        • SDN dns index. GET /cluster/sdn/dns

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { type?: "powerdns" }
            • Optional type?: "powerdns"

          Returns Promise<clusterSdnDnsIndex[]>

      • $post:function
        • $post(param: { dns: string; key: string; reversemaskv6?: number; reversev6mask?: number; ttl?: number; type: "powerdns"; url: string }): Promise<null>

        • Create a new sdn dns object. POST /cluster/sdn/dns

          Allowtoken

          1

          Permissions

          Parameters

          • param: { dns: string; key: string; reversemaskv6?: number; reversev6mask?: number; ttl?: number; type: "powerdns"; url: string }
            • dns: string
            • key: string
            • Optional reversemaskv6?: number
            • Optional reversev6mask?: number
            • Optional ttl?: number
            • type: "powerdns"
            • url: string

          Returns Promise<null>

    • ipams: { $: any; $get: any; $post: any }
      • $:function
        • $(ipam: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • ipam: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Delete sdn ipam object configuration. DELETE /cluster/sdn/ipams/{ipam}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(): Promise<any>

            • Read sdn ipam configuration. GET /cluster/sdn/ipams/{ipam}

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $put:function
            • $put(param?: { delete?: string; digest?: string; section?: number; token?: string; url?: string }): Promise<null>

            • Update sdn ipam object configuration. PUT /cluster/sdn/ipams/{ipam}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { delete?: string; digest?: string; section?: number; token?: string; url?: string }
                • Optional delete?: string
                • Optional digest?: string
                • Optional section?: number
                • Optional token?: string
                • Optional url?: string

              Returns Promise<null>

      • $get:function
      • $post:function
        • $post(param: { ipam: string; section?: number; token?: string; type: pveconfigid_4; url?: string }): Promise<null>

        • Create a new sdn ipam object. POST /cluster/sdn/ipams

          Allowtoken

          1

          Permissions

          Parameters

          • param: { ipam: string; section?: number; token?: string; type: pveconfigid_4; url?: string }
            • ipam: string
            • Optional section?: number
            • Optional token?: string
            • type: pveconfigid_4
            • Optional url?: string

          Returns Promise<null>

    • vnets: { $: any; $get: any; $post: any }
      • $:function
        • $(vnet: string): { subnets: { $: any; $get: any; $post: any }; $delete: any; $get: any; $put: any }

        • Parameters

          • vnet: string

          Returns { subnets: { $: any; $get: any; $post: any }; $delete: any; $get: any; $put: any }

          • subnets: { $: any; $get: any; $post: any }
            • $:function
              • $(subnet: string): { $delete: any; $get: any; $put: any }

              • Parameters

                • subnet: string

                Returns { $delete: any; $get: any; $put: any }

                • $delete:function
                  • $delete(): Promise<null>

                  • Delete sdn subnet object configuration. DELETE /cluster/sdn/vnets/{vnet}/subnets/{subnet}

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<null>

                • $get:function
                  • $get(param?: { pending?: boolean; running?: boolean }): Promise<any>

                  • Read sdn subnet configuration. GET /cluster/sdn/vnets/{vnet}/subnets/{subnet}

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { pending?: boolean; running?: boolean }
                      • Optional pending?: boolean
                      • Optional running?: boolean

                    Returns Promise<any>

                • $put:function
                  • $put(param?: { delete?: string; digest?: string; dnszoneprefix?: string; gateway?: string; snat?: boolean }): Promise<null>

                  • Update sdn subnet object configuration. PUT /cluster/sdn/vnets/{vnet}/subnets/{subnet}

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { delete?: string; digest?: string; dnszoneprefix?: string; gateway?: string; snat?: boolean }
                      • Optional delete?: string
                      • Optional digest?: string
                      • Optional dnszoneprefix?: string
                      • Optional gateway?: string
                      • Optional snat?: boolean

                    Returns Promise<null>

            • $get:function
              • $get(param?: { pending?: boolean; running?: boolean }): Promise<clusterSdnVnetsSubnetsIndex[]>

              • SDN subnets index. GET /cluster/sdn/vnets/{vnet}/subnets

                Allowtoken

                1

                Permissions

                Parameters

                • Optional param: { pending?: boolean; running?: boolean }
                  • Optional pending?: boolean
                  • Optional running?: boolean

                Returns Promise<clusterSdnVnetsSubnetsIndex[]>

            • $post:function
              • $post(param: { dnszoneprefix?: string; gateway?: string; snat?: boolean; subnet: string; type: "subnet" }): Promise<null>

              • Create a new sdn subnet object. POST /cluster/sdn/vnets/{vnet}/subnets

                Allowtoken

                1

                Permissions

                Parameters

                • param: { dnszoneprefix?: string; gateway?: string; snat?: boolean; subnet: string; type: "subnet" }
                  • Optional dnszoneprefix?: string
                  • Optional gateway?: string
                  • Optional snat?: boolean
                  • subnet: string
                  • type: "subnet"

                Returns Promise<null>

          • $delete:function
            • $delete(): Promise<null>

            • Delete sdn vnet object configuration. DELETE /cluster/sdn/vnets/{vnet}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(param?: { pending?: boolean; running?: boolean }): Promise<any>

            • Read sdn vnet configuration. GET /cluster/sdn/vnets/{vnet}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { pending?: boolean; running?: boolean }
                • Optional pending?: boolean
                • Optional running?: boolean

              Returns Promise<any>

          • $put:function
            • $put(param?: { alias?: string; delete?: string; digest?: string; tag?: number; vlanaware?: boolean; zone?: string }): Promise<null>

            • Update sdn vnet object configuration. PUT /cluster/sdn/vnets/{vnet}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { alias?: string; delete?: string; digest?: string; tag?: number; vlanaware?: boolean; zone?: string }
                • Optional alias?: string
                • Optional delete?: string
                • Optional digest?: string
                • Optional tag?: number
                • Optional vlanaware?: boolean
                • Optional zone?: string

              Returns Promise<null>

      • $get:function
        • $get(param?: { pending?: boolean; running?: boolean }): Promise<clusterSdnVnetsIndex[]>

        • SDN vnets index. GET /cluster/sdn/vnets

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { pending?: boolean; running?: boolean }
            • Optional pending?: boolean
            • Optional running?: boolean

          Returns Promise<clusterSdnVnetsIndex[]>

      • $post:function
        • $post(param: { alias?: string; tag?: number; type?: "vnet"; vlanaware?: boolean; vnet: string; zone: string }): Promise<null>

        • Create a new sdn vnet object. POST /cluster/sdn/vnets

          Allowtoken

          1

          Permissions

          Parameters

          • param: { alias?: string; tag?: number; type?: "vnet"; vlanaware?: boolean; vnet: string; zone: string }
            • Optional alias?: string
            • Optional tag?: number
            • Optional type?: "vnet"
            • Optional vlanaware?: boolean
            • vnet: string
            • zone: string

          Returns Promise<null>

    • zones: { $: any; $get: any; $post: any }
      • $:function
        • $(zone: string): { $delete: any; $get: any; $put: any }

        • Parameters

          • zone: string

          Returns { $delete: any; $get: any; $put: any }

          • $delete:function
            • $delete(): Promise<null>

            • Delete sdn zone object configuration. DELETE /cluster/sdn/zones/{zone}

              Allowtoken

              1

              Permissions

              Returns Promise<null>

          • $get:function
            • $get(param?: { pending?: boolean; running?: boolean }): Promise<any>

            • Read sdn zone configuration. GET /cluster/sdn/zones/{zone}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { pending?: boolean; running?: boolean }
                • Optional pending?: boolean
                • Optional running?: boolean

              Returns Promise<any>

          • $put:function
            • $put(param?: { advertise-subnets?: boolean; bridge?: string; controller?: string; delete?: string; digest?: string; disable-arp-nd-suppression?: boolean; dns?: string; dnszone?: string; dp-id?: number; exitnodes?: string; exitnodes-local-routing?: boolean; ipam?: string; mac?: string; mtu?: number; nodes?: string; peers?: string; reversedns?: string; tag?: number; vlan-protocol?: Tvlanprotocol; vrf-vxlan?: number }): Promise<null>

            • Update sdn zone object configuration. PUT /cluster/sdn/zones/{zone}

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { advertise-subnets?: boolean; bridge?: string; controller?: string; delete?: string; digest?: string; disable-arp-nd-suppression?: boolean; dns?: string; dnszone?: string; dp-id?: number; exitnodes?: string; exitnodes-local-routing?: boolean; ipam?: string; mac?: string; mtu?: number; nodes?: string; peers?: string; reversedns?: string; tag?: number; vlan-protocol?: Tvlanprotocol; vrf-vxlan?: number }
                • Optional advertise-subnets?: boolean
                • Optional bridge?: string
                • Optional controller?: string
                • Optional delete?: string
                • Optional digest?: string
                • Optional disable-arp-nd-suppression?: boolean
                • Optional dns?: string
                • Optional dnszone?: string
                • Optional dp-id?: number
                • Optional exitnodes?: string
                • Optional exitnodes-local-routing?: boolean
                • Optional ipam?: string
                • Optional mac?: string
                • Optional mtu?: number
                • Optional nodes?: string
                • Optional peers?: string
                • Optional reversedns?: string
                • Optional tag?: number
                • Optional vlan-protocol?: Tvlanprotocol
                • Optional vrf-vxlan?: number

              Returns Promise<null>

      • $get:function
        • $get(param?: { pending?: boolean; running?: boolean; type?: Ttype_8 }): Promise<clusterSdnZonesIndex[]>

        • SDN zones index. GET /cluster/sdn/zones

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { pending?: boolean; running?: boolean; type?: Ttype_8 }
            • Optional pending?: boolean
            • Optional running?: boolean
            • Optional type?: Ttype_8

          Returns Promise<clusterSdnZonesIndex[]>

      • $post:function
        • $post(param: { advertise-subnets?: boolean; bridge?: string; controller?: string; disable-arp-nd-suppression?: boolean; dns?: string; dnszone?: string; dp-id?: number; exitnodes?: string; exitnodes-local-routing?: boolean; ipam?: string; mac?: string; mtu?: number; nodes?: string; peers?: string; reversedns?: string; tag?: number; type: pveconfigid_2; vlan-protocol?: Tvlanprotocol; vrf-vxlan?: number; zone: string }): Promise<null>

        • Create a new sdn zone object. POST /cluster/sdn/zones

          Allowtoken

          1

          Permissions

          Parameters

          • param: { advertise-subnets?: boolean; bridge?: string; controller?: string; disable-arp-nd-suppression?: boolean; dns?: string; dnszone?: string; dp-id?: number; exitnodes?: string; exitnodes-local-routing?: boolean; ipam?: string; mac?: string; mtu?: number; nodes?: string; peers?: string; reversedns?: string; tag?: number; type: pveconfigid_2; vlan-protocol?: Tvlanprotocol; vrf-vxlan?: number; zone: string }
            • Optional advertise-subnets?: boolean
            • Optional bridge?: string
            • Optional controller?: string
            • Optional disable-arp-nd-suppression?: boolean
            • Optional dns?: string
            • Optional dnszone?: string
            • Optional dp-id?: number
            • Optional exitnodes?: string
            • Optional exitnodes-local-routing?: boolean
            • Optional ipam?: string
            • Optional mac?: string
            • Optional mtu?: number
            • Optional nodes?: string
            • Optional peers?: string
            • Optional reversedns?: string
            • Optional tag?: number
            • type: pveconfigid_2
            • Optional vlan-protocol?: Tvlanprotocol
            • Optional vrf-vxlan?: number
            • zone: string

          Returns Promise<null>

    • $get:function
    • $put:function
      • $put(): Promise<string>

      • Apply sdn controller changes && reload. PUT /cluster/sdn

        Allowtoken

        1

        Permissions

        Returns Promise<string>

  • status: { $get: any }
  • tasks: { $get: any }
  • $get:function

nodes

nodes: { $: any; $get: any }

Type declaration

  • $:function
    • $(node: string): { aplinfo: { $get: any; $post: any }; apt: { changelog: { $get: any }; repositories: { $get: any; $post: any; $put: any }; update: { $get: any; $post: any }; versions: { $get: any }; $get: any }; capabilities: { qemu: { cpu: { $get: any }; machines: { $get: any }; $get: any }; $get: any }; ceph: { config: { $get: any }; configdb: { $get: any }; crush: { $get: any }; fs: { $: any; $get: any }; init: { $post: any }; log: { $get: any }; mds: { $: any; $get: any }; mgr: { $: any; $get: any }; mon: { $: any; $get: any }; osd: { $: any; $get: any; $post: any }; pools: { $: any; $get: any; $post: any }; restart: { $post: any }; rules: { $get: any }; start: { $post: any }; status: { $get: any }; stop: { $post: any }; $get: any }; certificates: { acme: { certificate: { $delete: any; $post: any; $put: any }; $get: any }; custom: { $delete: any; $post: any }; info: { $get: any }; $get: any }; config: { $get: any; $put: any }; disks: { directory: { $: any; $get: any; $post: any }; initgpt: { $post: any }; list: { $get: any }; lvm: { $: any; $get: any; $post: any }; lvmthin: { $: any; $get: any; $post: any }; smart: { $get: any }; wipedisk: { $put: any }; zfs: { $: any; $get: any; $post: any }; $get: any }; dns: { $get: any; $put: any }; execute: { $post: any }; firewall: { log: { $get: any }; options: { $get: any; $put: any }; rules: { $: any; $get: any; $post: any }; $get: any }; hardware: { pci: { $: any; $get: any }; usb: { $get: any }; $get: any }; hosts: { $get: any; $post: any }; journal: { $get: any }; lxc: { $: any; $get: any; $post: any }; migrateall: { $post: any }; netstat: { $get: any }; network: { $: any; $delete: any; $get: any; $post: any; $put: any }; qemu: { $: any; $get: any; $post: any }; query-url-metadata: { $get: any }; replication: { $: any; $get: any }; report: { $get: any }; rrd: { $get: any }; rrddata: { $get: any }; scan: { cifs: { $get: any }; glusterfs: { $get: any }; iscsi: { $get: any }; lvm: { $get: any }; lvmthin: { $get: any }; nfs: { $get: any }; pbs: { $get: any }; zfs: { $get: any }; $get: any }; sdn: { zones: { $: any; $get: any }; $get: any }; services: { $: any; $get: any }; spiceshell: { $post: any }; startall: { $post: any }; status: { $get: any; $post: any }; stopall: { $post: any }; storage: { $: any; $get: any }; subscription: { $delete: any; $get: any; $post: any; $put: any }; syslog: { $get: any }; tasks: { $: any; $get: any }; termproxy: { $post: any }; time: { $get: any; $put: any }; version: { $get: any }; vncshell: { $post: any }; vncwebsocket: { $get: any }; vzdump: { defaults: { $get: any }; extractconfig: { $get: any }; $post: any }; wakeonlan: { $post: any }; $get: any }

    • Parameters

      • node: string

      Returns { aplinfo: { $get: any; $post: any }; apt: { changelog: { $get: any }; repositories: { $get: any; $post: any; $put: any }; update: { $get: any; $post: any }; versions: { $get: any }; $get: any }; capabilities: { qemu: { cpu: { $get: any }; machines: { $get: any }; $get: any }; $get: any }; ceph: { config: { $get: any }; configdb: { $get: any }; crush: { $get: any }; fs: { $: any; $get: any }; init: { $post: any }; log: { $get: any }; mds: { $: any; $get: any }; mgr: { $: any; $get: any }; mon: { $: any; $get: any }; osd: { $: any; $get: any; $post: any }; pools: { $: any; $get: any; $post: any }; restart: { $post: any }; rules: { $get: any }; start: { $post: any }; status: { $get: any }; stop: { $post: any }; $get: any }; certificates: { acme: { certificate: { $delete: any; $post: any; $put: any }; $get: any }; custom: { $delete: any; $post: any }; info: { $get: any }; $get: any }; config: { $get: any; $put: any }; disks: { directory: { $: any; $get: any; $post: any }; initgpt: { $post: any }; list: { $get: any }; lvm: { $: any; $get: any; $post: any }; lvmthin: { $: any; $get: any; $post: any }; smart: { $get: any }; wipedisk: { $put: any }; zfs: { $: any; $get: any; $post: any }; $get: any }; dns: { $get: any; $put: any }; execute: { $post: any }; firewall: { log: { $get: any }; options: { $get: any; $put: any }; rules: { $: any; $get: any; $post: any }; $get: any }; hardware: { pci: { $: any; $get: any }; usb: { $get: any }; $get: any }; hosts: { $get: any; $post: any }; journal: { $get: any }; lxc: { $: any; $get: any; $post: any }; migrateall: { $post: any }; netstat: { $get: any }; network: { $: any; $delete: any; $get: any; $post: any; $put: any }; qemu: { $: any; $get: any; $post: any }; query-url-metadata: { $get: any }; replication: { $: any; $get: any }; report: { $get: any }; rrd: { $get: any }; rrddata: { $get: any }; scan: { cifs: { $get: any }; glusterfs: { $get: any }; iscsi: { $get: any }; lvm: { $get: any }; lvmthin: { $get: any }; nfs: { $get: any }; pbs: { $get: any }; zfs: { $get: any }; $get: any }; sdn: { zones: { $: any; $get: any }; $get: any }; services: { $: any; $get: any }; spiceshell: { $post: any }; startall: { $post: any }; status: { $get: any; $post: any }; stopall: { $post: any }; storage: { $: any; $get: any }; subscription: { $delete: any; $get: any; $post: any; $put: any }; syslog: { $get: any }; tasks: { $: any; $get: any }; termproxy: { $post: any }; time: { $get: any; $put: any }; version: { $get: any }; vncshell: { $post: any }; vncwebsocket: { $get: any }; vzdump: { defaults: { $get: any }; extractconfig: { $get: any }; $post: any }; wakeonlan: { $post: any }; $get: any }

      • aplinfo: { $get: any; $post: any }
        • $get:function
        • $post:function
          • $post(param: { storage: string; template: string }): Promise<string>

          • Download appliance templates. POST /nodes/{node}/aplinfo

            Allowtoken

            1

            Permissions

            Parameters

            • param: { storage: string; template: string }
              • storage: string
              • template: string

            Returns Promise<string>

      • apt: { changelog: { $get: any }; repositories: { $get: any; $post: any; $put: any }; update: { $get: any; $post: any }; versions: { $get: any }; $get: any }
        • changelog: { $get: any }
          • $get:function
            • $get(param: { name: string; version?: string }): Promise<string>

            • Get package changelogs. GET /nodes/{node}/apt/changelog

              Allowtoken

              1

              Permissions

              Parameters

              • param: { name: string; version?: string }
                • name: string
                • Optional version?: string

              Returns Promise<string>

        • repositories: { $get: any; $post: any; $put: any }
          • $get:function
          • $post:function
            • $post(param: { digest?: string; enabled?: boolean; index: number; path: string }): Promise<null>

            • Change the properties of a repository. Currently only allows enabling/disabling. POST /nodes/{node}/apt/repositories

              Allowtoken

              1

              Permissions

              Parameters

              • param: { digest?: string; enabled?: boolean; index: number; path: string }
                • Optional digest?: string
                • Optional enabled?: boolean
                • index: number
                • path: string

              Returns Promise<null>

          • $put:function
            • $put(param: { digest?: string; handle: string }): Promise<null>

            • Add a standard repository to the configuration PUT /nodes/{node}/apt/repositories

              Allowtoken

              1

              Permissions

              Parameters

              • param: { digest?: string; handle: string }
                • Optional digest?: string
                • handle: string

              Returns Promise<null>

        • update: { $get: any; $post: any }
          • $get:function
          • $post:function
            • $post(param?: { notify?: boolean; quiet?: boolean }): Promise<string>

            • This is used to resynchronize the package index files from their sources (apt-get update). POST /nodes/{node}/apt/update

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { notify?: boolean; quiet?: boolean }
                • Optional notify?: boolean
                • Optional quiet?: boolean

              Returns Promise<string>

        • versions: { $get: any }
        • $get:function
      • capabilities: { qemu: { cpu: { $get: any }; machines: { $get: any }; $get: any }; $get: any }
      • ceph: { config: { $get: any }; configdb: { $get: any }; crush: { $get: any }; fs: { $: any; $get: any }; init: { $post: any }; log: { $get: any }; mds: { $: any; $get: any }; mgr: { $: any; $get: any }; mon: { $: any; $get: any }; osd: { $: any; $get: any; $post: any }; pools: { $: any; $get: any; $post: any }; restart: { $post: any }; rules: { $get: any }; start: { $post: any }; status: { $get: any }; stop: { $post: any }; $get: any }
        • config: { $get: any }
          • $get:function
            • $get(): Promise<string>

            • Get Ceph configuration. GET /nodes/{node}/ceph/config

              Allowtoken

              1

              Permissions

              Returns Promise<string>

        • configdb: { $get: any }
        • crush: { $get: any }
          • $get:function
            • $get(): Promise<string>

            • Get OSD crush map GET /nodes/{node}/ceph/crush

              Allowtoken

              1

              Permissions

              Returns Promise<string>

        • fs: { $: any; $get: any }
          • $:function
            • $(name: string): { $post: any }

            • Parameters

              • name: string

              Returns { $post: any }

              • $post:function
                • $post(param?: { add-storage?: boolean; pg_num?: number }): Promise<string>

                • Create a Ceph filesystem POST /nodes/{node}/ceph/fs/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { add-storage?: boolean; pg_num?: number }
                    • Optional add-storage?: boolean
                    • Optional pg_num?: number

                  Returns Promise<string>

          • $get:function
        • init: { $post: any }
          • $post:function
            • $post(param?: { cluster-network?: string; disable_cephx?: boolean; min_size?: number; network?: string; pg_bits?: number; size?: number }): Promise<null>

            • Create initial ceph default configuration and setup symlinks. POST /nodes/{node}/ceph/init

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { cluster-network?: string; disable_cephx?: boolean; min_size?: number; network?: string; pg_bits?: number; size?: number }
                • Optional cluster-network?: string
                • Optional disable_cephx?: boolean
                • Optional min_size?: number
                • Optional network?: string
                • Optional pg_bits?: number
                • Optional size?: number

              Returns Promise<null>

        • log: { $get: any }
          • $get:function
            • $get(param?: { limit?: number; start?: number }): Promise<nodesCephLogLog[]>

            • Read ceph log GET /nodes/{node}/ceph/log

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { limit?: number; start?: number }
                • Optional limit?: number
                • Optional start?: number

              Returns Promise<nodesCephLogLog[]>

        • mds: { $: any; $get: any }
          • $:function
            • $(name: string): { $delete: any; $post: any }

            • Parameters

              • name: string

              Returns { $delete: any; $post: any }

              • $delete:function
                • $delete(): Promise<string>

                • Destroy Ceph Metadata Server DELETE /nodes/{node}/ceph/mds/{name}

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

              • $post:function
                • $post(param?: { hotstandby?: boolean }): Promise<string>

                • Create Ceph Metadata Server (MDS) POST /nodes/{node}/ceph/mds/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { hotstandby?: boolean }
                    • Optional hotstandby?: boolean

                  Returns Promise<string>

          • $get:function
        • mgr: { $: any; $get: any }
          • $:function
            • $(id: string): { $delete: any; $post: any }

            • Parameters

              • id: string

              Returns { $delete: any; $post: any }

              • $delete:function
                • $delete(): Promise<string>

                • Destroy Ceph Manager. DELETE /nodes/{node}/ceph/mgr/{id}

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

              • $post:function
                • $post(): Promise<string>

                • Create Ceph Manager POST /nodes/{node}/ceph/mgr/{id}

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

          • $get:function
        • mon: { $: any; $get: any }
          • $:function
            • $(monid: string): { $delete: any; $post: any }

            • Parameters

              • monid: string

              Returns { $delete: any; $post: any }

              • $delete:function
                • $delete(): Promise<string>

                • Destroy Ceph Monitor and Manager. DELETE /nodes/{node}/ceph/mon/{monid}

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

              • $post:function
                • $post(param?: { mon-address?: string }): Promise<string>

                • Create Ceph Monitor and Manager POST /nodes/{node}/ceph/mon/{monid}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { mon-address?: string }
                    • Optional mon-address?: string

                  Returns Promise<string>

          • $get:function
        • osd: { $: any; $get: any; $post: any }
          • $:function
            • $(osdid: string): { in: { $post: any }; out: { $post: any }; scrub: { $post: any }; $delete: any }

            • Parameters

              • osdid: string

              Returns { in: { $post: any }; out: { $post: any }; scrub: { $post: any }; $delete: any }

              • in: { $post: any }
                • $post:function
                  • $post(): Promise<null>

                  • ceph osd in POST /nodes/{node}/ceph/osd/{osdid}/in

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<null>

              • out: { $post: any }
                • $post:function
                  • $post(): Promise<null>

                  • ceph osd out POST /nodes/{node}/ceph/osd/{osdid}/out

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<null>

              • scrub: { $post: any }
                • $post:function
                  • $post(param?: { deep?: boolean }): Promise<null>

                  • Instruct the OSD to scrub. POST /nodes/{node}/ceph/osd/{osdid}/scrub

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { deep?: boolean }
                      • Optional deep?: boolean

                    Returns Promise<null>

              • $delete:function
                • $delete(param?: { cleanup?: boolean }): Promise<string>

                • Destroy OSD DELETE /nodes/{node}/ceph/osd/{osdid}

                  Allowtoken

                  1

                  Parameters

                  • Optional param: { cleanup?: boolean }
                    • Optional cleanup?: boolean

                  Returns Promise<string>

          • $get:function
            • $get(): Promise<any>

            • Get Ceph osd list/tree. GET /nodes/{node}/ceph/osd

              Allowtoken

              1

              Permissions

              Returns Promise<any>

          • $post:function
            • $post(param: { crush-device-class?: string; db_dev?: string; db_dev_size?: number; dev: string; encrypted?: boolean; wal_dev?: string; wal_dev_size?: number }): Promise<string>

            • Create OSD POST /nodes/{node}/ceph/osd

              Allowtoken

              1

              Parameters

              • param: { crush-device-class?: string; db_dev?: string; db_dev_size?: number; dev: string; encrypted?: boolean; wal_dev?: string; wal_dev_size?: number }
                • Optional crush-device-class?: string
                • Optional db_dev?: string
                • Optional db_dev_size?: number
                • dev: string
                • Optional encrypted?: boolean
                • Optional wal_dev?: string
                • Optional wal_dev_size?: number

              Returns Promise<string>

        • pools: { $: any; $get: any; $post: any }
          • $:function
            • $(name: string): { $delete: any; $get: any; $put: any }

            • Parameters

              • name: string

              Returns { $delete: any; $get: any; $put: any }

              • $delete:function
                • $delete(param?: { force?: boolean; remove_storages?: boolean }): Promise<string>

                • Destroy pool DELETE /nodes/{node}/ceph/pools/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { force?: boolean; remove_storages?: boolean }
                    • Optional force?: boolean
                    • Optional remove_storages?: boolean

                  Returns Promise<string>

              • $get:function
                • $get(param?: { verbose?: boolean }): Promise<nodesCephPoolsGetpool>

                • List pool settings. GET /nodes/{node}/ceph/pools/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { verbose?: boolean }
                    • Optional verbose?: boolean

                  Returns Promise<nodesCephPoolsGetpool>

              • $put:function
                • $put(param?: { application?: Tapplication; crush_rule?: string; min_size?: number; pg_autoscale_mode?: Tpg_autoscale_mode; pg_num?: number; pg_num_min?: number; size?: number; target_size?: string; target_size_ratio?: number }): Promise<string>

                • Change POOL settings PUT /nodes/{node}/ceph/pools/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { application?: Tapplication; crush_rule?: string; min_size?: number; pg_autoscale_mode?: Tpg_autoscale_mode; pg_num?: number; pg_num_min?: number; size?: number; target_size?: string; target_size_ratio?: number }
                    • Optional application?: Tapplication
                    • Optional crush_rule?: string
                    • Optional min_size?: number
                    • Optional pg_autoscale_mode?: Tpg_autoscale_mode
                    • Optional pg_num?: number
                    • Optional pg_num_min?: number
                    • Optional size?: number
                    • Optional target_size?: string
                    • Optional target_size_ratio?: number

                  Returns Promise<string>

          • $get:function
          • $post:function
            • $post(param: { add_storages?: boolean; application?: Tapplication; crush_rule?: string; min_size?: number; name: string; pg_autoscale_mode?: Tpg_autoscale_mode; pg_num?: number; pg_num_min?: number; size?: number; target_size?: string; target_size_ratio?: number }): Promise<string>

            • Create POOL POST /nodes/{node}/ceph/pools

              Allowtoken

              1

              Permissions

              Parameters

              • param: { add_storages?: boolean; application?: Tapplication; crush_rule?: string; min_size?: number; name: string; pg_autoscale_mode?: Tpg_autoscale_mode; pg_num?: number; pg_num_min?: number; size?: number; target_size?: string; target_size_ratio?: number }
                • Optional add_storages?: boolean
                • Optional application?: Tapplication
                • Optional crush_rule?: string
                • Optional min_size?: number
                • name: string
                • Optional pg_autoscale_mode?: Tpg_autoscale_mode
                • Optional pg_num?: number
                • Optional pg_num_min?: number
                • Optional size?: number
                • Optional target_size?: string
                • Optional target_size_ratio?: number

              Returns Promise<string>

        • restart: { $post: any }
          • $post:function
            • $post(param?: { service?: string }): Promise<string>

            • Restart ceph services. POST /nodes/{node}/ceph/restart

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { service?: string }
                • Optional service?: string

              Returns Promise<string>

        • rules: { $get: any }
        • start: { $post: any }
          • $post:function
            • $post(param?: { service?: string }): Promise<string>

            • Start ceph services. POST /nodes/{node}/ceph/start

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { service?: string }
                • Optional service?: string

              Returns Promise<string>

        • status: { $get: any }
          • $get:function
            • $get(): Promise<any>

            • Get ceph status. GET /nodes/{node}/ceph/status

              Allowtoken

              1

              Permissions

              Returns Promise<any>

        • stop: { $post: any }
          • $post:function
            • $post(param?: { service?: string }): Promise<string>

            • Stop ceph services. POST /nodes/{node}/ceph/stop

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { service?: string }
                • Optional service?: string

              Returns Promise<string>

        • $get:function
      • certificates: { acme: { certificate: { $delete: any; $post: any; $put: any }; $get: any }; custom: { $delete: any; $post: any }; info: { $get: any }; $get: any }
        • acme: { certificate: { $delete: any; $post: any; $put: any }; $get: any }
          • certificate: { $delete: any; $post: any; $put: any }
            • $delete:function
              • $delete(): Promise<string>

              • Revoke existing certificate from CA. DELETE /nodes/{node}/certificates/acme/certificate

                Allowtoken

                1

                Permissions

                Returns Promise<string>

            • $post:function
              • $post(param?: { force?: boolean }): Promise<string>

              • Order a new certificate from ACME-compatible CA. POST /nodes/{node}/certificates/acme/certificate

                Allowtoken

                1

                Permissions

                Parameters

                • Optional param: { force?: boolean }
                  • Optional force?: boolean

                Returns Promise<string>

            • $put:function
              • $put(param?: { force?: boolean }): Promise<string>

              • Renew existing certificate from CA. PUT /nodes/{node}/certificates/acme/certificate

                Allowtoken

                1

                Permissions

                Parameters

                • Optional param: { force?: boolean }
                  • Optional force?: boolean

                Returns Promise<string>

          • $get:function
        • custom: { $delete: any; $post: any }
          • $delete:function
            • $delete(param?: { restart?: boolean }): Promise<null>

            • DELETE custom certificate chain and key. DELETE /nodes/{node}/certificates/custom

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { restart?: boolean }
                • Optional restart?: boolean

              Returns Promise<null>

          • $post:function
            • $post(param: { certificates: string; force?: boolean; key?: string; restart?: boolean }): Promise<nodesCertificatesCustomUploadCustomCert>

            • Upload or update custom certificate chain and key. POST /nodes/{node}/certificates/custom

              Allowtoken

              1

              Permissions

              Parameters

              • param: { certificates: string; force?: boolean; key?: string; restart?: boolean }
                • certificates: string
                • Optional force?: boolean
                • Optional key?: string
                • Optional restart?: boolean

              Returns Promise<nodesCertificatesCustomUploadCustomCert>

        • info: { $get: any }
        • $get:function
      • config: { $get: any; $put: any }
        • $get:function
          • $get(param?: { property?: Tproperty }): Promise<any>

          • Get node configuration options. GET /nodes/{node}/config

            Allowtoken

            1

            Permissions

            Parameters

            Returns Promise<any>

        • $put:function
          • $put(param?: { acme?: string; acmedomain0?: string; acmedomain1?: string; acmedomain2?: string; acmedomain3?: string; delete?: string; description?: string; digest?: string; startall-onboot-delay?: number; wakeonlan?: string }): Promise<null>

          • Set node configuration options. PUT /nodes/{node}/config

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { acme?: string; acmedomain0?: string; acmedomain1?: string; acmedomain2?: string; acmedomain3?: string; delete?: string; description?: string; digest?: string; startall-onboot-delay?: number; wakeonlan?: string }
              • Optional acme?: string
              • Optional acmedomain0?: string
              • Optional acmedomain1?: string
              • Optional acmedomain2?: string
              • Optional acmedomain3?: string
              • Optional delete?: string
              • Optional description?: string
              • Optional digest?: string
              • Optional startall-onboot-delay?: number
              • Optional wakeonlan?: string

            Returns Promise<null>

      • disks: { directory: { $: any; $get: any; $post: any }; initgpt: { $post: any }; list: { $get: any }; lvm: { $: any; $get: any; $post: any }; lvmthin: { $: any; $get: any; $post: any }; smart: { $get: any }; wipedisk: { $put: any }; zfs: { $: any; $get: any; $post: any }; $get: any }
        • directory: { $: any; $get: any; $post: any }
          • $:function
            • $(name: string): { $delete: any }

            • Parameters

              • name: string

              Returns { $delete: any }

              • $delete:function
                • $delete(param?: { cleanup-config?: boolean; cleanup-disks?: boolean }): Promise<string>

                • Unmounts the storage and removes the mount unit. DELETE /nodes/{node}/disks/directory/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { cleanup-config?: boolean; cleanup-disks?: boolean }
                    • Optional cleanup-config?: boolean
                    • Optional cleanup-disks?: boolean

                  Returns Promise<string>

          • $get:function
          • $post:function
            • $post(param: { add_storage?: boolean; device: string; filesystem?: Tfilesystem; name: string }): Promise<string>

            • Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'. POST /nodes/{node}/disks/directory

              Allowtoken

              1

              Permissions

              Parameters

              • param: { add_storage?: boolean; device: string; filesystem?: Tfilesystem; name: string }
                • Optional add_storage?: boolean
                • device: string
                • Optional filesystem?: Tfilesystem
                • name: string

              Returns Promise<string>

        • initgpt: { $post: any }
          • $post:function
            • $post(param: { disk: string; uuid?: string }): Promise<string>

            • Initialize Disk with GPT POST /nodes/{node}/disks/initgpt

              Allowtoken

              1

              Permissions

              Parameters

              • param: { disk: string; uuid?: string }
                • disk: string
                • Optional uuid?: string

              Returns Promise<string>

        • list: { $get: any }
          • $get:function
            • $get(param?: { include-partitions?: boolean; skipsmart?: boolean; type?: Ttype_17 }): Promise<nodesDisksListList[]>

            • List local disks. GET /nodes/{node}/disks/list

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { include-partitions?: boolean; skipsmart?: boolean; type?: Ttype_17 }
                • Optional include-partitions?: boolean
                • Optional skipsmart?: boolean
                • Optional type?: Ttype_17

              Returns Promise<nodesDisksListList[]>

        • lvm: { $: any; $get: any; $post: any }
          • $:function
            • $(name: string): { $delete: any }

            • Parameters

              • name: string

              Returns { $delete: any }

              • $delete:function
                • $delete(param?: { cleanup-config?: boolean; cleanup-disks?: boolean }): Promise<string>

                • Remove an LVM Volume Group. DELETE /nodes/{node}/disks/lvm/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { cleanup-config?: boolean; cleanup-disks?: boolean }
                    • Optional cleanup-config?: boolean
                    • Optional cleanup-disks?: boolean

                  Returns Promise<string>

          • $get:function
          • $post:function
            • $post(param: { add_storage?: boolean; device: string; name: string }): Promise<string>

            • Create an LVM Volume Group POST /nodes/{node}/disks/lvm

              Allowtoken

              1

              Permissions

              Parameters

              • param: { add_storage?: boolean; device: string; name: string }
                • Optional add_storage?: boolean
                • device: string
                • name: string

              Returns Promise<string>

        • lvmthin: { $: any; $get: any; $post: any }
          • $:function
            • $(name: string): { $delete: any }

            • Parameters

              • name: string

              Returns { $delete: any }

              • $delete:function
                • $delete(param: { cleanup-config?: boolean; cleanup-disks?: boolean; volume-group: string }): Promise<string>

                • Remove an LVM thin pool. DELETE /nodes/{node}/disks/lvmthin/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { cleanup-config?: boolean; cleanup-disks?: boolean; volume-group: string }
                    • Optional cleanup-config?: boolean
                    • Optional cleanup-disks?: boolean
                    • volume-group: string

                  Returns Promise<string>

          • $get:function
          • $post:function
            • $post(param: { add_storage?: boolean; device: string; name: string }): Promise<string>

            • Create an LVM thinpool POST /nodes/{node}/disks/lvmthin

              Allowtoken

              1

              Permissions

              Parameters

              • param: { add_storage?: boolean; device: string; name: string }
                • Optional add_storage?: boolean
                • device: string
                • name: string

              Returns Promise<string>

        • smart: { $get: any }
          • $get:function
            • $get(param: { disk: string; healthonly?: boolean }): Promise<nodesDisksSmartSmart>

            • Get SMART Health of a disk. GET /nodes/{node}/disks/smart

              Allowtoken

              1

              Permissions

              Parameters

              • param: { disk: string; healthonly?: boolean }
                • disk: string
                • Optional healthonly?: boolean

              Returns Promise<nodesDisksSmartSmart>

        • wipedisk: { $put: any }
          • $put:function
            • $put(param: { disk: string }): Promise<string>

            • Wipe a disk or partition. PUT /nodes/{node}/disks/wipedisk

              Allowtoken

              1

              Parameters

              • param: { disk: string }
                • disk: string

              Returns Promise<string>

        • zfs: { $: any; $get: any; $post: any }
          • $:function
            • $(name: string): { $delete: any; $get: any }

            • Parameters

              • name: string

              Returns { $delete: any; $get: any }

              • $delete:function
                • $delete(param?: { cleanup-config?: boolean; cleanup-disks?: boolean }): Promise<string>

                • Destroy a ZFS pool. DELETE /nodes/{node}/disks/zfs/{name}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { cleanup-config?: boolean; cleanup-disks?: boolean }
                    • Optional cleanup-config?: boolean
                    • Optional cleanup-disks?: boolean

                  Returns Promise<string>

              • $get:function
          • $get:function
          • $post:function
            • $post(param: { add_storage?: boolean; ashift?: number; compression?: Tcompression; devices: string; name: string; raidlevel: Traidlevel }): Promise<string>

            • Create a ZFS pool. POST /nodes/{node}/disks/zfs

              Allowtoken

              1

              Permissions

              Parameters

              • param: { add_storage?: boolean; ashift?: number; compression?: Tcompression; devices: string; name: string; raidlevel: Traidlevel }
                • Optional add_storage?: boolean
                • Optional ashift?: number
                • Optional compression?: Tcompression
                • devices: string
                • name: string
                • raidlevel: Traidlevel

              Returns Promise<string>

        • $get:function
      • dns: { $get: any; $put: any }
        • $get:function
        • $put:function
          • $put(param: { dns1?: string; dns2?: string; dns3?: string; search: string }): Promise<null>

          • Write DNS settings. PUT /nodes/{node}/dns

            Allowtoken

            1

            Permissions

            Parameters

            • param: { dns1?: string; dns2?: string; dns3?: string; search: string }
              • Optional dns1?: string
              • Optional dns2?: string
              • Optional dns3?: string
              • search: string

            Returns Promise<null>

      • execute: { $post: any }
        • $post:function
          • $post(param: { commands: string }): Promise<string[]>

          • Execute multiple commands in order. POST /nodes/{node}/execute

            Allowtoken

            1

            Permissions

            Parameters

            • param: { commands: string }
              • commands: string

            Returns Promise<string[]>

      • firewall: { log: { $get: any }; options: { $get: any; $put: any }; rules: { $: any; $get: any; $post: any }; $get: any }
        • log: { $get: any }
          • $get:function
            • $get(param?: { limit?: number; start?: number }): Promise<nodesFirewallLogLog[]>

            • Read firewall log GET /nodes/{node}/firewall/log

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { limit?: number; start?: number }
                • Optional limit?: number
                • Optional start?: number

              Returns Promise<nodesFirewallLogLog[]>

        • options: { $get: any; $put: any }
          • $get:function
          • $put:function
            • $put(param?: { delete?: string; digest?: string; enable?: boolean; log_level_in?: Tlog; log_level_out?: Tlog; log_nf_conntrack?: boolean; ndp?: boolean; nf_conntrack_allow_invalid?: boolean; nf_conntrack_max?: number; nf_conntrack_tcp_timeout_established?: number; nf_conntrack_tcp_timeout_syn_recv?: number; nosmurfs?: boolean; protection_synflood?: boolean; protection_synflood_burst?: number; protection_synflood_rate?: number; smurf_log_level?: Tlog; tcp_flags_log_level?: Tlog; tcpflags?: boolean }): Promise<null>

            • Set Firewall options. PUT /nodes/{node}/firewall/options

              Allowtoken

              1

              Permissions

              Parameters

              • Optional param: { delete?: string; digest?: string; enable?: boolean; log_level_in?: Tlog; log_level_out?: Tlog; log_nf_conntrack?: boolean; ndp?: boolean; nf_conntrack_allow_invalid?: boolean; nf_conntrack_max?: number; nf_conntrack_tcp_timeout_established?: number; nf_conntrack_tcp_timeout_syn_recv?: number; nosmurfs?: boolean; protection_synflood?: boolean; protection_synflood_burst?: number; protection_synflood_rate?: number; smurf_log_level?: Tlog; tcp_flags_log_level?: Tlog; tcpflags?: boolean }
                • Optional delete?: string
                • Optional digest?: string
                • Optional enable?: boolean
                • Optional log_level_in?: Tlog
                • Optional log_level_out?: Tlog
                • Optional log_nf_conntrack?: boolean
                • Optional ndp?: boolean
                • Optional nf_conntrack_allow_invalid?: boolean
                • Optional nf_conntrack_max?: number
                • Optional nf_conntrack_tcp_timeout_established?: number
                • Optional nf_conntrack_tcp_timeout_syn_recv?: number
                • Optional nosmurfs?: boolean
                • Optional protection_synflood?: boolean
                • Optional protection_synflood_burst?: number
                • Optional protection_synflood_rate?: number
                • Optional smurf_log_level?: Tlog
                • Optional tcp_flags_log_level?: Tlog
                • Optional tcpflags?: boolean

              Returns Promise<null>

        • rules: { $: any; $get: any; $post: any }
          • $:function
            • $(pos: string): { $delete: any; $get: any; $put: any }

            • Parameters

              • pos: string

              Returns { $delete: any; $get: any; $put: any }

              • $delete:function
                • $delete(param?: { digest?: string }): Promise<null>

                • Delete rule. DELETE /nodes/{node}/firewall/rules/{pos}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { digest?: string }
                    • Optional digest?: string

                  Returns Promise<null>

              • $get:function
              • $put:function
                • $put(param?: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }): Promise<null>

                • Modify rule data. PUT /nodes/{node}/firewall/rules/{pos}

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }
                    • Optional action?: string
                    • Optional comment?: string
                    • Optional delete?: string
                    • Optional dest?: string
                    • Optional digest?: string
                    • Optional dport?: string
                    • Optional enable?: number
                    • Optional icmp-type?: string
                    • Optional iface?: string
                    • Optional log?: Tlog
                    • Optional macro?: string
                    • Optional moveto?: number
                    • Optional proto?: string
                    • Optional source?: string
                    • Optional sport?: string
                    • Optional type?: Ttype_1

                  Returns Promise<null>

          • $get:function
          • $post:function
            • $post(param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }): Promise<null>

            • Create new rule. POST /nodes/{node}/firewall/rules

              Allowtoken

              1

              Permissions

              Parameters

              • param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }
                • action: string
                • Optional comment?: string
                • Optional dest?: string
                • Optional digest?: string
                • Optional dport?: string
                • Optional enable?: number
                • Optional icmp-type?: string
                • Optional iface?: string
                • Optional log?: Tlog
                • Optional macro?: string
                • Optional pos?: number
                • Optional proto?: string
                • Optional source?: string
                • Optional sport?: string
                • type: Ttype_1

              Returns Promise<null>

        • $get:function
      • hardware: { pci: { $: any; $get: any }; usb: { $get: any }; $get: any }
      • hosts: { $get: any; $post: any }
        • $get:function
        • $post:function
          • $post(param: { data: string; digest?: string }): Promise<null>

          • Write /etc/hosts. POST /nodes/{node}/hosts

            Allowtoken

            1

            Permissions

            Parameters

            • param: { data: string; digest?: string }
              • data: string
              • Optional digest?: string

            Returns Promise<null>

      • journal: { $get: any }
        • $get:function
          • $get(param?: { endcursor?: string; lastentries?: number; since?: number; startcursor?: string; until?: number }): Promise<string[]>

          • Read Journal GET /nodes/{node}/journal

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { endcursor?: string; lastentries?: number; since?: number; startcursor?: string; until?: number }
              • Optional endcursor?: string
              • Optional lastentries?: number
              • Optional since?: number
              • Optional startcursor?: string
              • Optional until?: number

            Returns Promise<string[]>

      • lxc: { $: any; $get: any; $post: any }
        • $:function
          • $(vmid: number): { clone: { $post: any }; config: { $get: any; $put: any }; feature: { $get: any }; firewall: { aliases: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; log: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }; migrate: { $post: any }; move_volume: { $post: any }; pending: { $get: any }; resize: { $put: any }; rrd: { $get: any }; rrddata: { $get: any }; snapshot: { $: any; $get: any; $post: any }; spiceproxy: { $post: any }; status: { current: { $get: any }; reboot: { $post: any }; resume: { $post: any }; shutdown: { $post: any }; start: { $post: any }; stop: { $post: any }; suspend: { $post: any }; $get: any }; template: { $post: any }; termproxy: { $post: any }; vncproxy: { $post: any }; vncwebsocket: { $get: any }; $delete: any; $get: any }

          • Parameters

            • vmid: number

            Returns { clone: { $post: any }; config: { $get: any; $put: any }; feature: { $get: any }; firewall: { aliases: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; log: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }; migrate: { $post: any }; move_volume: { $post: any }; pending: { $get: any }; resize: { $put: any }; rrd: { $get: any }; rrddata: { $get: any }; snapshot: { $: any; $get: any; $post: any }; spiceproxy: { $post: any }; status: { current: { $get: any }; reboot: { $post: any }; resume: { $post: any }; shutdown: { $post: any }; start: { $post: any }; stop: { $post: any }; suspend: { $post: any }; $get: any }; template: { $post: any }; termproxy: { $post: any }; vncproxy: { $post: any }; vncwebsocket: { $get: any }; $delete: any; $get: any }

            • clone: { $post: any }
              • $post:function
                • $post(param: { bwlimit?: number; description?: string; full?: boolean; hostname?: string; newid: number; pool?: string; snapname?: string; storage?: string; target?: string }): Promise<string>

                • Create a container clone/copy POST /nodes/{node}/lxc/{vmid}/clone

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { bwlimit?: number; description?: string; full?: boolean; hostname?: string; newid: number; pool?: string; snapname?: string; storage?: string; target?: string }
                    • Optional bwlimit?: number
                    • Optional description?: string
                    • Optional full?: boolean
                    • Optional hostname?: string
                    • newid: number
                    • Optional pool?: string
                    • Optional snapname?: string
                    • Optional storage?: string
                    • Optional target?: string

                  Returns Promise<string>

            • config: { $get: any; $put: any }
              • $get:function
                • $get(param?: { current?: boolean; snapshot?: string }): Promise<nodesLxcConfigVmConfig>

                • Get container configuration. GET /nodes/{node}/lxc/{vmid}/config

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { current?: boolean; snapshot?: string }
                    • Optional current?: boolean
                    • Optional snapshot?: string

                  Returns Promise<nodesLxcConfigVmConfig>

              • $put:function
                • $put(param?: { arch?: Tarch_1; cmode?: Tcmode; console?: boolean; cores?: number; cpulimit?: number; cpuunits?: number; debug?: boolean; delete?: string; description?: string; digest?: string; features?: string; hookscript?: string; hostname?: string; lock?: Tlock_1; memory?: number; mp0?: string; mp1?: string; mp2?: string; mp3?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; onboot?: boolean; ostype?: Tostype_1; protection?: boolean; revert?: string; rootfs?: string; searchdomain?: string; startup?: string; swap?: number; tags?: string; template?: boolean; timezone?: string; tty?: number; unprivileged?: boolean; unused0?: string; unused1?: string; unused2?: string; unused3?: string }): Promise<null>

                • Set container options. PUT /nodes/{node}/lxc/{vmid}/config

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { arch?: Tarch_1; cmode?: Tcmode; console?: boolean; cores?: number; cpulimit?: number; cpuunits?: number; debug?: boolean; delete?: string; description?: string; digest?: string; features?: string; hookscript?: string; hostname?: string; lock?: Tlock_1; memory?: number; mp0?: string; mp1?: string; mp2?: string; mp3?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; onboot?: boolean; ostype?: Tostype_1; protection?: boolean; revert?: string; rootfs?: string; searchdomain?: string; startup?: string; swap?: number; tags?: string; template?: boolean; timezone?: string; tty?: number; unprivileged?: boolean; unused0?: string; unused1?: string; unused2?: string; unused3?: string }
                    • Optional arch?: Tarch_1
                    • Optional cmode?: Tcmode
                    • Optional console?: boolean
                    • Optional cores?: number
                    • Optional cpulimit?: number
                    • Optional cpuunits?: number
                    • Optional debug?: boolean
                    • Optional delete?: string
                    • Optional description?: string
                    • Optional digest?: string
                    • Optional features?: string
                    • Optional hookscript?: string
                    • Optional hostname?: string
                    • Optional lock?: Tlock_1
                    • Optional memory?: number
                    • Optional mp0?: string
                    • Optional mp1?: string
                    • Optional mp2?: string
                    • Optional mp3?: string
                    • Optional nameserver?: string
                    • Optional net0?: string
                    • Optional net1?: string
                    • Optional net2?: string
                    • Optional net3?: string
                    • Optional onboot?: boolean
                    • Optional ostype?: Tostype_1
                    • Optional protection?: boolean
                    • Optional revert?: string
                    • Optional rootfs?: string
                    • Optional searchdomain?: string
                    • Optional startup?: string
                    • Optional swap?: number
                    • Optional tags?: string
                    • Optional template?: boolean
                    • Optional timezone?: string
                    • Optional tty?: number
                    • Optional unprivileged?: boolean
                    • Optional unused0?: string
                    • Optional unused1?: string
                    • Optional unused2?: string
                    • Optional unused3?: string

                  Returns Promise<null>

            • feature: { $get: any }
            • firewall: { aliases: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; log: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }
              • aliases: { $: any; $get: any; $post: any }
                • $:function
                  • $(name: string): { $delete: any; $get: any; $put: any }

                  • Parameters

                    • name: string

                    Returns { $delete: any; $get: any; $put: any }

                    • $delete:function
                      • $delete(param?: { digest?: string }): Promise<null>

                      • Remove IP or Network alias. DELETE /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { digest?: string }
                          • Optional digest?: string

                        Returns Promise<null>

                    • $get:function
                      • $get(): Promise<any>

                      • Read alias. GET /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<any>

                    • $put:function
                      • $put(param: { cidr: string; comment?: string; digest?: string; rename?: string }): Promise<null>

                      • Update IP or Network alias. PUT /nodes/{node}/lxc/{vmid}/firewall/aliases/{name}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • param: { cidr: string; comment?: string; digest?: string; rename?: string }
                          • cidr: string
                          • Optional comment?: string
                          • Optional digest?: string
                          • Optional rename?: string

                        Returns Promise<null>

                • $get:function
                • $post:function
                  • $post(param: { cidr: string; comment?: string; name: string }): Promise<null>

                  • Create IP or Network Alias. POST /nodes/{node}/lxc/{vmid}/firewall/aliases

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { cidr: string; comment?: string; name: string }
                      • cidr: string
                      • Optional comment?: string
                      • name: string

                    Returns Promise<null>

              • ipset: { $: any; $get: any; $post: any }
                • $:function
                  • $(name: string): { $: any; $delete: any; $get: any; $post: any }

                  • Parameters

                    • name: string

                    Returns { $: any; $delete: any; $get: any; $post: any }

                    • $:function
                      • $(cidr: string): { $delete: any; $get: any; $put: any }

                      • Parameters

                        • cidr: string

                        Returns { $delete: any; $get: any; $put: any }

                        • $delete:function
                          • $delete(param?: { digest?: string }): Promise<null>

                          • Remove IP or Network from IPSet. DELETE /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}

                            Allowtoken

                            1

                            Permissions

                            Parameters

                            • Optional param: { digest?: string }
                              • Optional digest?: string

                            Returns Promise<null>

                        • $get:function
                          • $get(): Promise<any>

                          • Read IP or Network settings from IPSet. GET /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}

                            Allowtoken

                            1

                            Permissions

                            Returns Promise<any>

                        • $put:function
                          • $put(param?: { comment?: string; digest?: string; nomatch?: boolean }): Promise<null>

                          • Update IP or Network settings PUT /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}

                            Allowtoken

                            1

                            Permissions

                            Parameters

                            • Optional param: { comment?: string; digest?: string; nomatch?: boolean }
                              • Optional comment?: string
                              • Optional digest?: string
                              • Optional nomatch?: boolean

                            Returns Promise<null>

                    • $delete:function
                      • $delete(): Promise<null>

                      • Delete IPSet DELETE /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<null>

                    • $get:function
                    • $post:function
                      • $post(param: { cidr: string; comment?: string; nomatch?: boolean }): Promise<null>

                      • Add IP or Network to IPSet. POST /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • param: { cidr: string; comment?: string; nomatch?: boolean }
                          • cidr: string
                          • Optional comment?: string
                          • Optional nomatch?: boolean

                        Returns Promise<null>

                • $get:function
                • $post:function
                  • $post(param: { comment?: string; digest?: string; name: string; rename?: string }): Promise<null>

                  • Create new IPSet POST /nodes/{node}/lxc/{vmid}/firewall/ipset

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { comment?: string; digest?: string; name: string; rename?: string }
                      • Optional comment?: string
                      • Optional digest?: string
                      • name: string
                      • Optional rename?: string

                    Returns Promise<null>

              • log: { $get: any }
                • $get:function
                  • $get(param?: { limit?: number; start?: number }): Promise<nodesLxcFirewallLogLog[]>

                  • Read firewall log GET /nodes/{node}/lxc/{vmid}/firewall/log

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { limit?: number; start?: number }
                      • Optional limit?: number
                      • Optional start?: number

                    Returns Promise<nodesLxcFirewallLogLog[]>

              • options: { $get: any; $put: any }
                • $get:function
                • $put:function
                  • $put(param?: { delete?: string; dhcp?: boolean; digest?: string; enable?: boolean; ipfilter?: boolean; log_level_in?: Tlog; log_level_out?: Tlog; macfilter?: boolean; ndp?: boolean; policy_in?: Tpolicy_in; policy_out?: Tpolicy_in; radv?: boolean }): Promise<null>

                  • Set Firewall options. PUT /nodes/{node}/lxc/{vmid}/firewall/options

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { delete?: string; dhcp?: boolean; digest?: string; enable?: boolean; ipfilter?: boolean; log_level_in?: Tlog; log_level_out?: Tlog; macfilter?: boolean; ndp?: boolean; policy_in?: Tpolicy_in; policy_out?: Tpolicy_in; radv?: boolean }
                      • Optional delete?: string
                      • Optional dhcp?: boolean
                      • Optional digest?: string
                      • Optional enable?: boolean
                      • Optional ipfilter?: boolean
                      • Optional log_level_in?: Tlog
                      • Optional log_level_out?: Tlog
                      • Optional macfilter?: boolean
                      • Optional ndp?: boolean
                      • Optional policy_in?: Tpolicy_in
                      • Optional policy_out?: Tpolicy_in
                      • Optional radv?: boolean

                    Returns Promise<null>

              • refs: { $get: any }
              • rules: { $: any; $get: any; $post: any }
                • $:function
                  • $(pos: string): { $delete: any; $get: any; $put: any }

                  • Parameters

                    • pos: string

                    Returns { $delete: any; $get: any; $put: any }

                    • $delete:function
                      • $delete(param?: { digest?: string }): Promise<null>

                      • Delete rule. DELETE /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { digest?: string }
                          • Optional digest?: string

                        Returns Promise<null>

                    • $get:function
                    • $put:function
                      • $put(param?: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }): Promise<null>

                      • Modify rule data. PUT /nodes/{node}/lxc/{vmid}/firewall/rules/{pos}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }
                          • Optional action?: string
                          • Optional comment?: string
                          • Optional delete?: string
                          • Optional dest?: string
                          • Optional digest?: string
                          • Optional dport?: string
                          • Optional enable?: number
                          • Optional icmp-type?: string
                          • Optional iface?: string
                          • Optional log?: Tlog
                          • Optional macro?: string
                          • Optional moveto?: number
                          • Optional proto?: string
                          • Optional source?: string
                          • Optional sport?: string
                          • Optional type?: Ttype_1

                        Returns Promise<null>

                • $get:function
                • $post:function
                  • $post(param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }): Promise<null>

                  • Create new rule. POST /nodes/{node}/lxc/{vmid}/firewall/rules

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }
                      • action: string
                      • Optional comment?: string
                      • Optional dest?: string
                      • Optional digest?: string
                      • Optional dport?: string
                      • Optional enable?: number
                      • Optional icmp-type?: string
                      • Optional iface?: string
                      • Optional log?: Tlog
                      • Optional macro?: string
                      • Optional pos?: number
                      • Optional proto?: string
                      • Optional source?: string
                      • Optional sport?: string
                      • type: Ttype_1

                    Returns Promise<null>

              • $get:function
            • migrate: { $post: any }
              • $post:function
                • $post(param: { bwlimit?: number; online?: boolean; restart?: boolean; target: string; timeout?: number }): Promise<string>

                • Migrate the container to another node. Creates a new migration task. POST /nodes/{node}/lxc/{vmid}/migrate

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { bwlimit?: number; online?: boolean; restart?: boolean; target: string; timeout?: number }
                    • Optional bwlimit?: number
                    • Optional online?: boolean
                    • Optional restart?: boolean
                    • target: string
                    • Optional timeout?: number

                  Returns Promise<string>

            • move_volume: { $post: any }
              • $post:function
                • $post(param: { bwlimit?: number; delete?: boolean; digest?: string; storage?: string; target-digest?: string; target-vmid?: number; target-volume?: Ttargetvolume; volume: Ttargetvolume }): Promise<string>

                • Move a rootfs-/mp-volume to a different storage or to a different container. POST /nodes/{node}/lxc/{vmid}/move_volume

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { bwlimit?: number; delete?: boolean; digest?: string; storage?: string; target-digest?: string; target-vmid?: number; target-volume?: Ttargetvolume; volume: Ttargetvolume }
                    • Optional bwlimit?: number
                    • Optional delete?: boolean
                    • Optional digest?: string
                    • Optional storage?: string
                    • Optional target-digest?: string
                    • Optional target-vmid?: number
                    • Optional target-volume?: Ttargetvolume
                    • volume: Ttargetvolume

                  Returns Promise<string>

            • pending: { $get: any }
            • resize: { $put: any }
              • $put:function
                • $put(param: { digest?: string; disk: Tdisk_2; size: string }): Promise<string>

                • Resize a container mount point. PUT /nodes/{node}/lxc/{vmid}/resize

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { digest?: string; disk: Tdisk_2; size: string }
                    • Optional digest?: string
                    • disk: Tdisk_2
                    • size: string

                  Returns Promise<string>

            • rrd: { $get: any }
            • rrddata: { $get: any }
            • snapshot: { $: any; $get: any; $post: any }
              • $:function
                • $(snapname: string): { config: { $get: any; $put: any }; rollback: { $post: any }; $delete: any; $get: any }

                • Parameters

                  • snapname: string

                  Returns { config: { $get: any; $put: any }; rollback: { $post: any }; $delete: any; $get: any }

                  • config: { $get: any; $put: any }
                    • $get:function
                      • $get(): Promise<any>

                      • Get snapshot configuration GET /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<any>

                    • $put:function
                      • $put(param?: { description?: string }): Promise<null>

                      • Update snapshot metadata. PUT /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { description?: string }
                          • Optional description?: string

                        Returns Promise<null>

                  • rollback: { $post: any }
                    • $post:function
                      • $post(): Promise<string>

                      • Rollback LXC state to specified snapshot. POST /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<string>

                  • $delete:function
                    • $delete(param?: { force?: boolean }): Promise<string>

                    • Delete a LXC snapshot. DELETE /nodes/{node}/lxc/{vmid}/snapshot/{snapname}

                      Allowtoken

                      1

                      Permissions

                      Parameters

                      • Optional param: { force?: boolean }
                        • Optional force?: boolean

                      Returns Promise<string>

                  • $get:function
              • $get:function
              • $post:function
                • $post(param: { description?: string; snapname: string }): Promise<string>

                • Snapshot a container. POST /nodes/{node}/lxc/{vmid}/snapshot

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { description?: string; snapname: string }
                    • Optional description?: string
                    • snapname: string

                  Returns Promise<string>

            • spiceproxy: { $post: any }
              • $post:function
            • status: { current: { $get: any }; reboot: { $post: any }; resume: { $post: any }; shutdown: { $post: any }; start: { $post: any }; stop: { $post: any }; suspend: { $post: any }; $get: any }
              • current: { $get: any }
              • reboot: { $post: any }
                • $post:function
                  • $post(param?: { timeout?: number }): Promise<string>

                  • Reboot the container by shutting it down, and starting it again. Applies pending changes. POST /nodes/{node}/lxc/{vmid}/status/reboot

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { timeout?: number }
                      • Optional timeout?: number

                    Returns Promise<string>

              • resume: { $post: any }
                • $post:function
                  • $post(): Promise<string>

                  • Resume the container. POST /nodes/{node}/lxc/{vmid}/status/resume

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<string>

              • shutdown: { $post: any }
                • $post:function
                  • $post(param?: { forceStop?: boolean; timeout?: number }): Promise<string>

                  • Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details. POST /nodes/{node}/lxc/{vmid}/status/shutdown

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { forceStop?: boolean; timeout?: number }
                      • Optional forceStop?: boolean
                      • Optional timeout?: number

                    Returns Promise<string>

              • start: { $post: any }
                • $post:function
                  • $post(param?: { debug?: boolean; skiplock?: boolean }): Promise<string>

                  • Start the container. POST /nodes/{node}/lxc/{vmid}/status/start

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { debug?: boolean; skiplock?: boolean }
                      • Optional debug?: boolean
                      • Optional skiplock?: boolean

                    Returns Promise<string>

              • stop: { $post: any }
                • $post:function
                  • $post(param?: { skiplock?: boolean }): Promise<string>

                  • Stop the container. This will abruptly stop all processes running in the container. POST /nodes/{node}/lxc/{vmid}/status/stop

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { skiplock?: boolean }
                      • Optional skiplock?: boolean

                    Returns Promise<string>

              • suspend: { $post: any }
                • $post:function
                  • $post(): Promise<string>

                  • Suspend the container. This is experimental. POST /nodes/{node}/lxc/{vmid}/status/suspend

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<string>

              • $get:function
            • template: { $post: any }
              • $post:function
                • $post(): Promise<null>

                • Create a Template. POST /nodes/{node}/lxc/{vmid}/template

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<null>

            • termproxy: { $post: any }
            • vncproxy: { $post: any }
              • $post:function
                • $post(param?: { height?: number; websocket?: boolean; width?: number }): Promise<nodesLxcVncproxyVncproxy>

                • Creates a TCP VNC proxy connections. POST /nodes/{node}/lxc/{vmid}/vncproxy

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { height?: number; websocket?: boolean; width?: number }
                    • Optional height?: number
                    • Optional websocket?: boolean
                    • Optional width?: number

                  Returns Promise<nodesLxcVncproxyVncproxy>

            • vncwebsocket: { $get: any }
            • $delete:function
              • $delete(param?: { destroy-unreferenced-disks?: boolean; force?: boolean; purge?: boolean }): Promise<string>

              • Destroy the container (also delete all uses files). DELETE /nodes/{node}/lxc/{vmid}

                Allowtoken

                1

                Permissions

                Parameters

                • Optional param: { destroy-unreferenced-disks?: boolean; force?: boolean; purge?: boolean }
                  • Optional destroy-unreferenced-disks?: boolean
                  • Optional force?: boolean
                  • Optional purge?: boolean

                Returns Promise<string>

            • $get:function
        • $get:function
        • $post:function
          • $post(param: { arch?: Tarch_1; bwlimit?: number; cmode?: Tcmode; console?: boolean; cores?: number; cpulimit?: number; cpuunits?: number; debug?: boolean; description?: string; features?: string; force?: boolean; hookscript?: string; hostname?: string; ignore-unpack-errors?: boolean; lock?: Tlock_1; memory?: number; mp0?: string; mp1?: string; mp2?: string; mp3?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; onboot?: boolean; ostemplate: string; ostype?: Tostype_1; password?: string; pool?: string; protection?: boolean; restore?: boolean; rootfs?: string; searchdomain?: string; ssh-public-keys?: string; start?: boolean; startup?: string; storage?: string; swap?: number; tags?: string; template?: boolean; timezone?: string; tty?: number; unique?: boolean; unprivileged?: boolean; unused0?: string; unused1?: string; unused2?: string; unused3?: string; vmid: number }): Promise<string>

          • Create or restore a container. POST /nodes/{node}/lxc

            Allowtoken

            1

            Permissions

            Parameters

            • param: { arch?: Tarch_1; bwlimit?: number; cmode?: Tcmode; console?: boolean; cores?: number; cpulimit?: number; cpuunits?: number; debug?: boolean; description?: string; features?: string; force?: boolean; hookscript?: string; hostname?: string; ignore-unpack-errors?: boolean; lock?: Tlock_1; memory?: number; mp0?: string; mp1?: string; mp2?: string; mp3?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; onboot?: boolean; ostemplate: string; ostype?: Tostype_1; password?: string; pool?: string; protection?: boolean; restore?: boolean; rootfs?: string; searchdomain?: string; ssh-public-keys?: string; start?: boolean; startup?: string; storage?: string; swap?: number; tags?: string; template?: boolean; timezone?: string; tty?: number; unique?: boolean; unprivileged?: boolean; unused0?: string; unused1?: string; unused2?: string; unused3?: string; vmid: number }
              • Optional arch?: Tarch_1
              • Optional bwlimit?: number
              • Optional cmode?: Tcmode
              • Optional console?: boolean
              • Optional cores?: number
              • Optional cpulimit?: number
              • Optional cpuunits?: number
              • Optional debug?: boolean
              • Optional description?: string
              • Optional features?: string
              • Optional force?: boolean
              • Optional hookscript?: string
              • Optional hostname?: string
              • Optional ignore-unpack-errors?: boolean
              • Optional lock?: Tlock_1
              • Optional memory?: number
              • Optional mp0?: string
              • Optional mp1?: string
              • Optional mp2?: string
              • Optional mp3?: string
              • Optional nameserver?: string
              • Optional net0?: string
              • Optional net1?: string
              • Optional net2?: string
              • Optional net3?: string
              • Optional onboot?: boolean
              • ostemplate: string
              • Optional ostype?: Tostype_1
              • Optional password?: string
              • Optional pool?: string
              • Optional protection?: boolean
              • Optional restore?: boolean
              • Optional rootfs?: string
              • Optional searchdomain?: string
              • Optional ssh-public-keys?: string
              • Optional start?: boolean
              • Optional startup?: string
              • Optional storage?: string
              • Optional swap?: number
              • Optional tags?: string
              • Optional template?: boolean
              • Optional timezone?: string
              • Optional tty?: number
              • Optional unique?: boolean
              • Optional unprivileged?: boolean
              • Optional unused0?: string
              • Optional unused1?: string
              • Optional unused2?: string
              • Optional unused3?: string
              • vmid: number

            Returns Promise<string>

      • migrateall: { $post: any }
        • $post:function
          • $post(param: { maxworkers?: number; target: string; vms?: string; with-local-disks?: boolean }): Promise<string>

          • Migrate all VMs and Containers. POST /nodes/{node}/migrateall

            Allowtoken

            1

            Permissions

            Parameters

            • param: { maxworkers?: number; target: string; vms?: string; with-local-disks?: boolean }
              • Optional maxworkers?: number
              • target: string
              • Optional vms?: string
              • Optional with-local-disks?: boolean

            Returns Promise<string>

      • netstat: { $get: any }
      • network: { $: any; $delete: any; $get: any; $post: any; $put: any }
        • $:function
          • $(iface: string): { $delete: any; $get: any; $put: any }

          • Parameters

            • iface: string

            Returns { $delete: any; $get: any; $put: any }

            • $delete:function
              • $delete(): Promise<null>

              • Delete network device configuration DELETE /nodes/{node}/network/{iface}

                Allowtoken

                1

                Permissions

                Returns Promise<null>

            • $get:function
            • $put:function
              • $put(param: { address?: string; address6?: string; autostart?: boolean; bond-primary?: string; bond_mode?: Tbond_mode; bond_xmit_hash_policy?: Tbond_xmit_hash_policy; bridge_ports?: string; bridge_vlan_aware?: boolean; cidr?: string; cidr6?: string; comments?: string; comments6?: string; delete?: string; gateway?: string; gateway6?: string; mtu?: number; netmask?: string; netmask6?: number; ovs_bonds?: string; ovs_bridge?: string; ovs_options?: string; ovs_ports?: string; ovs_tag?: number; slaves?: string; type: Ttype_15; vlan-id?: number; vlan-raw-device?: string }): Promise<null>

              • Update network device configuration PUT /nodes/{node}/network/{iface}

                Allowtoken

                1

                Permissions

                Parameters

                • param: { address?: string; address6?: string; autostart?: boolean; bond-primary?: string; bond_mode?: Tbond_mode; bond_xmit_hash_policy?: Tbond_xmit_hash_policy; bridge_ports?: string; bridge_vlan_aware?: boolean; cidr?: string; cidr6?: string; comments?: string; comments6?: string; delete?: string; gateway?: string; gateway6?: string; mtu?: number; netmask?: string; netmask6?: number; ovs_bonds?: string; ovs_bridge?: string; ovs_options?: string; ovs_ports?: string; ovs_tag?: number; slaves?: string; type: Ttype_15; vlan-id?: number; vlan-raw-device?: string }
                  • Optional address?: string
                  • Optional address6?: string
                  • Optional autostart?: boolean
                  • Optional bond-primary?: string
                  • Optional bond_mode?: Tbond_mode
                  • Optional bond_xmit_hash_policy?: Tbond_xmit_hash_policy
                  • Optional bridge_ports?: string
                  • Optional bridge_vlan_aware?: boolean
                  • Optional cidr?: string
                  • Optional cidr6?: string
                  • Optional comments?: string
                  • Optional comments6?: string
                  • Optional delete?: string
                  • Optional gateway?: string
                  • Optional gateway6?: string
                  • Optional mtu?: number
                  • Optional netmask?: string
                  • Optional netmask6?: number
                  • Optional ovs_bonds?: string
                  • Optional ovs_bridge?: string
                  • Optional ovs_options?: string
                  • Optional ovs_ports?: string
                  • Optional ovs_tag?: number
                  • Optional slaves?: string
                  • type: Ttype_15
                  • Optional vlan-id?: number
                  • Optional vlan-raw-device?: string

                Returns Promise<null>

        • $delete:function
          • $delete(): Promise<null>

          • Revert network configuration changes. DELETE /nodes/{node}/network

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
        • $post:function
          • $post(param: { address?: string; address6?: string; autostart?: boolean; bond-primary?: string; bond_mode?: Tbond_mode; bond_xmit_hash_policy?: Tbond_xmit_hash_policy; bridge_ports?: string; bridge_vlan_aware?: boolean; cidr?: string; cidr6?: string; comments?: string; comments6?: string; gateway?: string; gateway6?: string; iface: string; mtu?: number; netmask?: string; netmask6?: number; ovs_bonds?: string; ovs_bridge?: string; ovs_options?: string; ovs_ports?: string; ovs_tag?: number; slaves?: string; type: Ttype_15; vlan-id?: number; vlan-raw-device?: string }): Promise<null>

          • Create network device configuration POST /nodes/{node}/network

            Allowtoken

            1

            Permissions

            Parameters

            • param: { address?: string; address6?: string; autostart?: boolean; bond-primary?: string; bond_mode?: Tbond_mode; bond_xmit_hash_policy?: Tbond_xmit_hash_policy; bridge_ports?: string; bridge_vlan_aware?: boolean; cidr?: string; cidr6?: string; comments?: string; comments6?: string; gateway?: string; gateway6?: string; iface: string; mtu?: number; netmask?: string; netmask6?: number; ovs_bonds?: string; ovs_bridge?: string; ovs_options?: string; ovs_ports?: string; ovs_tag?: number; slaves?: string; type: Ttype_15; vlan-id?: number; vlan-raw-device?: string }
              • Optional address?: string
              • Optional address6?: string
              • Optional autostart?: boolean
              • Optional bond-primary?: string
              • Optional bond_mode?: Tbond_mode
              • Optional bond_xmit_hash_policy?: Tbond_xmit_hash_policy
              • Optional bridge_ports?: string
              • Optional bridge_vlan_aware?: boolean
              • Optional cidr?: string
              • Optional cidr6?: string
              • Optional comments?: string
              • Optional comments6?: string
              • Optional gateway?: string
              • Optional gateway6?: string
              • iface: string
              • Optional mtu?: number
              • Optional netmask?: string
              • Optional netmask6?: number
              • Optional ovs_bonds?: string
              • Optional ovs_bridge?: string
              • Optional ovs_options?: string
              • Optional ovs_ports?: string
              • Optional ovs_tag?: number
              • Optional slaves?: string
              • type: Ttype_15
              • Optional vlan-id?: number
              • Optional vlan-raw-device?: string

            Returns Promise<null>

        • $put:function
          • $put(): Promise<string>

          • Reload network configuration PUT /nodes/{node}/network

            Allowtoken

            1

            Permissions

            Returns Promise<string>

      • qemu: { $: any; $get: any; $post: any }
        • $:function
          • $(vmid: number): { agent: { exec: { $post: any }; exec-status: { $get: any }; file-read: { $get: any }; file-write: { $post: any }; fsfreeze-freeze: { $post: any }; fsfreeze-status: { $post: any }; fsfreeze-thaw: { $post: any }; fstrim: { $post: any }; get-fsinfo: { $get: any }; get-host-name: { $get: any }; get-memory-block-info: { $get: any }; get-memory-blocks: { $get: any }; get-osinfo: { $get: any }; get-time: { $get: any }; get-timezone: { $get: any }; get-users: { $get: any }; get-vcpus: { $get: any }; info: { $get: any }; network-get-interfaces: { $get: any }; ping: { $post: any }; set-user-password: { $post: any }; shutdown: { $post: any }; suspend-disk: { $post: any }; suspend-hybrid: { $post: any }; suspend-ram: { $post: any }; $get: any; $post: any }; clone: { $post: any }; cloudinit: { dump: { $get: any } }; config: { $get: any; $post: any; $put: any }; feature: { $get: any }; firewall: { aliases: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; log: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }; migrate: { $get: any; $post: any }; monitor: { $post: any }; move_disk: { $post: any }; pending: { $get: any }; resize: { $put: any }; rrd: { $get: any }; rrddata: { $get: any }; sendkey: { $put: any }; snapshot: { $: any; $get: any; $post: any }; spiceproxy: { $post: any }; status: { current: { $get: any }; reboot: { $post: any }; reset: { $post: any }; resume: { $post: any }; shutdown: { $post: any }; start: { $post: any }; stop: { $post: any }; suspend: { $post: any }; $get: any }; template: { $post: any }; termproxy: { $post: any }; unlink: { $put: any }; vncproxy: { $post: any }; vncwebsocket: { $get: any }; $delete: any; $get: any }

          • Parameters

            • vmid: number

            Returns { agent: { exec: { $post: any }; exec-status: { $get: any }; file-read: { $get: any }; file-write: { $post: any }; fsfreeze-freeze: { $post: any }; fsfreeze-status: { $post: any }; fsfreeze-thaw: { $post: any }; fstrim: { $post: any }; get-fsinfo: { $get: any }; get-host-name: { $get: any }; get-memory-block-info: { $get: any }; get-memory-blocks: { $get: any }; get-osinfo: { $get: any }; get-time: { $get: any }; get-timezone: { $get: any }; get-users: { $get: any }; get-vcpus: { $get: any }; info: { $get: any }; network-get-interfaces: { $get: any }; ping: { $post: any }; set-user-password: { $post: any }; shutdown: { $post: any }; suspend-disk: { $post: any }; suspend-hybrid: { $post: any }; suspend-ram: { $post: any }; $get: any; $post: any }; clone: { $post: any }; cloudinit: { dump: { $get: any } }; config: { $get: any; $post: any; $put: any }; feature: { $get: any }; firewall: { aliases: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; log: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }; migrate: { $get: any; $post: any }; monitor: { $post: any }; move_disk: { $post: any }; pending: { $get: any }; resize: { $put: any }; rrd: { $get: any }; rrddata: { $get: any }; sendkey: { $put: any }; snapshot: { $: any; $get: any; $post: any }; spiceproxy: { $post: any }; status: { current: { $get: any }; reboot: { $post: any }; reset: { $post: any }; resume: { $post: any }; shutdown: { $post: any }; start: { $post: any }; stop: { $post: any }; suspend: { $post: any }; $get: any }; template: { $post: any }; termproxy: { $post: any }; unlink: { $put: any }; vncproxy: { $post: any }; vncwebsocket: { $get: any }; $delete: any; $get: any }

            • agent: { exec: { $post: any }; exec-status: { $get: any }; file-read: { $get: any }; file-write: { $post: any }; fsfreeze-freeze: { $post: any }; fsfreeze-status: { $post: any }; fsfreeze-thaw: { $post: any }; fstrim: { $post: any }; get-fsinfo: { $get: any }; get-host-name: { $get: any }; get-memory-block-info: { $get: any }; get-memory-blocks: { $get: any }; get-osinfo: { $get: any }; get-time: { $get: any }; get-timezone: { $get: any }; get-users: { $get: any }; get-vcpus: { $get: any }; info: { $get: any }; network-get-interfaces: { $get: any }; ping: { $post: any }; set-user-password: { $post: any }; shutdown: { $post: any }; suspend-disk: { $post: any }; suspend-hybrid: { $post: any }; suspend-ram: { $post: any }; $get: any; $post: any }
              • exec: { $post: any }
                • $post:function
                  • $post(param?: { command?: string; input-data?: string }): Promise<nodesQemuAgentExecExec>

                  • Executes the given command in the vm via the guest-agent and returns an object with the pid. POST /nodes/{node}/qemu/{vmid}/agent/exec

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { command?: string; input-data?: string }
                      • Optional command?: string
                      • Optional input-data?: string

                    Returns Promise<nodesQemuAgentExecExec>

              • exec-status: { $get: any }
              • file-read: { $get: any }
              • file-write: { $post: any }
                • $post:function
                  • $post(param: { content: string; file: string }): Promise<null>

                  • Writes the given file via guest agent. POST /nodes/{node}/qemu/{vmid}/agent/file-write

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { content: string; file: string }
                      • content: string
                      • file: string

                    Returns Promise<null>

              • fsfreeze-freeze: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute fsfreeze-freeze. POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • fsfreeze-status: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute fsfreeze-status. POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-status

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • fsfreeze-thaw: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute fsfreeze-thaw. POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • fstrim: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute fstrim. POST /nodes/{node}/qemu/{vmid}/agent/fstrim

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-fsinfo: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-fsinfo. GET /nodes/{node}/qemu/{vmid}/agent/get-fsinfo

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-host-name: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-host-name. GET /nodes/{node}/qemu/{vmid}/agent/get-host-name

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-memory-block-info: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-memory-block-info. GET /nodes/{node}/qemu/{vmid}/agent/get-memory-block-info

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-memory-blocks: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-memory-blocks. GET /nodes/{node}/qemu/{vmid}/agent/get-memory-blocks

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-osinfo: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-osinfo. GET /nodes/{node}/qemu/{vmid}/agent/get-osinfo

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-time: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-time. GET /nodes/{node}/qemu/{vmid}/agent/get-time

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-timezone: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-timezone. GET /nodes/{node}/qemu/{vmid}/agent/get-timezone

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-users: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-users. GET /nodes/{node}/qemu/{vmid}/agent/get-users

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • get-vcpus: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute get-vcpus. GET /nodes/{node}/qemu/{vmid}/agent/get-vcpus

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • info: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute info. GET /nodes/{node}/qemu/{vmid}/agent/info

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • network-get-interfaces: { $get: any }
                • $get:function
                  • $get(): Promise<any>

                  • Execute network-get-interfaces. GET /nodes/{node}/qemu/{vmid}/agent/network-get-interfaces

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • ping: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute ping. POST /nodes/{node}/qemu/{vmid}/agent/ping

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • set-user-password: { $post: any }
                • $post:function
                  • $post(param: { crypted?: boolean; password: string; username: string }): Promise<any>

                  • Sets the password for the given user to the given password POST /nodes/{node}/qemu/{vmid}/agent/set-user-password

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { crypted?: boolean; password: string; username: string }
                      • Optional crypted?: boolean
                      • password: string
                      • username: string

                    Returns Promise<any>

              • shutdown: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute shutdown. POST /nodes/{node}/qemu/{vmid}/agent/shutdown

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • suspend-disk: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute suspend-disk. POST /nodes/{node}/qemu/{vmid}/agent/suspend-disk

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • suspend-hybrid: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute suspend-hybrid. POST /nodes/{node}/qemu/{vmid}/agent/suspend-hybrid

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • suspend-ram: { $post: any }
                • $post:function
                  • $post(): Promise<any>

                  • Execute suspend-ram. POST /nodes/{node}/qemu/{vmid}/agent/suspend-ram

                    Allowtoken

                    1

                    Permissions

                    Returns Promise<any>

              • $get:function
              • $post:function
                • $post(param: { command: Tcommand }): Promise<any>

                • Execute Qemu Guest Agent commands. POST /nodes/{node}/qemu/{vmid}/agent

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  Returns Promise<any>

            • clone: { $post: any }
              • $post:function
                • $post(param: { bwlimit?: number; description?: string; format?: Tformat; full?: boolean; name?: string; newid: number; pool?: string; snapname?: string; storage?: string; target?: string }): Promise<string>

                • Create a copy of virtual machine/template. POST /nodes/{node}/qemu/{vmid}/clone

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { bwlimit?: number; description?: string; format?: Tformat; full?: boolean; name?: string; newid: number; pool?: string; snapname?: string; storage?: string; target?: string }
                    • Optional bwlimit?: number
                    • Optional description?: string
                    • Optional format?: Tformat
                    • Optional full?: boolean
                    • Optional name?: string
                    • newid: number
                    • Optional pool?: string
                    • Optional snapname?: string
                    • Optional storage?: string
                    • Optional target?: string

                  Returns Promise<string>

            • cloudinit: { dump: { $get: any } }
              • dump: { $get: any }
                • $get:function
                  • $get(param: { type: Ttype_13 }): Promise<string>

                  • Get automatically generated cloudinit config. GET /nodes/{node}/qemu/{vmid}/cloudinit/dump

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    Returns Promise<string>

            • config: { $get: any; $post: any; $put: any }
              • $get:function
                • $get(param?: { current?: boolean; snapshot?: string }): Promise<nodesQemuConfigVmConfig>

                • Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead. GET /nodes/{node}/qemu/{vmid}/config

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { current?: boolean; snapshot?: string }
                    • Optional current?: boolean
                    • Optional snapshot?: string

                  Returns Promise<nodesQemuConfigVmConfig>

              • $post:function
                • $post(param?: { acpi?: boolean; agent?: string; arch?: Tarch; args?: string; audio0?: string; autostart?: boolean; background_delay?: number; balloon?: number; bios?: Tbios; boot?: string; bootdisk?: string; cdrom?: string; cicustom?: string; cipassword?: string; citype?: Tcitype; ciuser?: string; cores?: number; cpu?: string; cpulimit?: number; cpuunits?: number; delete?: string; description?: string; digest?: string; efidisk0?: string; force?: boolean; freeze?: boolean; hookscript?: string; hostpci0?: string; hostpci1?: string; hostpci2?: string; hostpci3?: string; hostpci4?: string; hostpci5?: string; hostpci6?: string; hostpci7?: string; hotplug?: string; hugepages?: Thugepages; ide0?: string; ide1?: string; ide2?: string; ide3?: string; ipconfig0?: string; ipconfig1?: string; ipconfig2?: string; ipconfig3?: string; ipconfig4?: string; ipconfig5?: string; ipconfig6?: string; ipconfig7?: string; ivshmem?: string; keephugepages?: boolean; keyboard?: Tkeyboard; kvm?: boolean; localtime?: boolean; lock?: Tlock; machine?: string; memory?: number; migrate_downtime?: number; migrate_speed?: number; name?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; numa?: boolean; numa0?: string; numa1?: string; numa2?: string; numa3?: string; onboot?: boolean; ostype?: Tostype; parallel0?: string; parallel1?: string; parallel2?: string; parallel3?: string; protection?: boolean; reboot?: boolean; revert?: string; rng0?: string; sata0?: string; sata1?: string; sata2?: string; sata3?: string; scsi0?: string; scsi1?: string; scsi2?: string; scsi3?: string; scsihw?: Tscsihw; searchdomain?: string; serial0?: string; serial1?: string; serial2?: string; serial3?: string; shares?: number; skiplock?: boolean; smbios1?: string; smp?: number; sockets?: number; spice_enhancements?: string; sshkeys?: string; startdate?: string; startup?: string; tablet?: boolean; tags?: string; tdf?: boolean; template?: boolean; tpmstate0?: string; unused0?: string; unused1?: string; unused2?: string; unused3?: string; usb0?: string; usb1?: string; usb2?: string; usb3?: string; vcpus?: number; vga?: string; virtio0?: string; virtio1?: string; virtio2?: string; virtio3?: string; vmgenid?: string; vmstatestorage?: string; watchdog?: string }): Promise<string>

                • Set virtual machine options (asynchrounous API). POST /nodes/{node}/qemu/{vmid}/config

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { acpi?: boolean; agent?: string; arch?: Tarch; args?: string; audio0?: string; autostart?: boolean; background_delay?: number; balloon?: number; bios?: Tbios; boot?: string; bootdisk?: string; cdrom?: string; cicustom?: string; cipassword?: string; citype?: Tcitype; ciuser?: string; cores?: number; cpu?: string; cpulimit?: number; cpuunits?: number; delete?: string; description?: string; digest?: string; efidisk0?: string; force?: boolean; freeze?: boolean; hookscript?: string; hostpci0?: string; hostpci1?: string; hostpci2?: string; hostpci3?: string; hostpci4?: string; hostpci5?: string; hostpci6?: string; hostpci7?: string; hotplug?: string; hugepages?: Thugepages; ide0?: string; ide1?: string; ide2?: string; ide3?: string; ipconfig0?: string; ipconfig1?: string; ipconfig2?: string; ipconfig3?: string; ipconfig4?: string; ipconfig5?: string; ipconfig6?: string; ipconfig7?: string; ivshmem?: string; keephugepages?: boolean; keyboard?: Tkeyboard; kvm?: boolean; localtime?: boolean; lock?: Tlock; machine?: string; memory?: number; migrate_downtime?: number; migrate_speed?: number; name?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; numa?: boolean; numa0?: string; numa1?: string; numa2?: string; numa3?: string; onboot?: boolean; ostype?: Tostype; parallel0?: string; parallel1?: string; parallel2?: string; parallel3?: string; protection?: boolean; reboot?: boolean; revert?: string; rng0?: string; sata0?: string; sata1?: string; sata2?: string; sata3?: string; scsi0?: string; scsi1?: string; scsi2?: string; scsi3?: string; scsihw?: Tscsihw; searchdomain?: string; serial0?: string; serial1?: string; serial2?: string; serial3?: string; shares?: number; skiplock?: boolean; smbios1?: string; smp?: number; sockets?: number; spice_enhancements?: string; sshkeys?: string; startdate?: string; startup?: string; tablet?: boolean; tags?: string; tdf?: boolean; template?: boolean; tpmstate0?: string; unused0?: string; unused1?: string; unused2?: string; unused3?: string; usb0?: string; usb1?: string; usb2?: string; usb3?: string; vcpus?: number; vga?: string; virtio0?: string; virtio1?: string; virtio2?: string; virtio3?: string; vmgenid?: string; vmstatestorage?: string; watchdog?: string }
                    • Optional acpi?: boolean
                    • Optional agent?: string
                    • Optional arch?: Tarch
                    • Optional args?: string
                    • Optional audio0?: string
                    • Optional autostart?: boolean
                    • Optional background_delay?: number
                    • Optional balloon?: number
                    • Optional bios?: Tbios
                    • Optional boot?: string
                    • Optional bootdisk?: string
                    • Optional cdrom?: string
                    • Optional cicustom?: string
                    • Optional cipassword?: string
                    • Optional citype?: Tcitype
                    • Optional ciuser?: string
                    • Optional cores?: number
                    • Optional cpu?: string
                    • Optional cpulimit?: number
                    • Optional cpuunits?: number
                    • Optional delete?: string
                    • Optional description?: string
                    • Optional digest?: string
                    • Optional efidisk0?: string
                    • Optional force?: boolean
                    • Optional freeze?: boolean
                    • Optional hookscript?: string
                    • Optional hostpci0?: string
                    • Optional hostpci1?: string
                    • Optional hostpci2?: string
                    • Optional hostpci3?: string
                    • Optional hostpci4?: string
                    • Optional hostpci5?: string
                    • Optional hostpci6?: string
                    • Optional hostpci7?: string
                    • Optional hotplug?: string
                    • Optional hugepages?: Thugepages
                    • Optional ide0?: string
                    • Optional ide1?: string
                    • Optional ide2?: string
                    • Optional ide3?: string
                    • Optional ipconfig0?: string
                    • Optional ipconfig1?: string
                    • Optional ipconfig2?: string
                    • Optional ipconfig3?: string
                    • Optional ipconfig4?: string
                    • Optional ipconfig5?: string
                    • Optional ipconfig6?: string
                    • Optional ipconfig7?: string
                    • Optional ivshmem?: string
                    • Optional keephugepages?: boolean
                    • Optional keyboard?: Tkeyboard
                    • Optional kvm?: boolean
                    • Optional localtime?: boolean
                    • Optional lock?: Tlock
                    • Optional machine?: string
                    • Optional memory?: number
                    • Optional migrate_downtime?: number
                    • Optional migrate_speed?: number
                    • Optional name?: string
                    • Optional nameserver?: string
                    • Optional net0?: string
                    • Optional net1?: string
                    • Optional net2?: string
                    • Optional net3?: string
                    • Optional numa?: boolean
                    • Optional numa0?: string
                    • Optional numa1?: string
                    • Optional numa2?: string
                    • Optional numa3?: string
                    • Optional onboot?: boolean
                    • Optional ostype?: Tostype
                    • Optional parallel0?: string
                    • Optional parallel1?: string
                    • Optional parallel2?: string
                    • Optional parallel3?: string
                    • Optional protection?: boolean
                    • Optional reboot?: boolean
                    • Optional revert?: string
                    • Optional rng0?: string
                    • Optional sata0?: string
                    • Optional sata1?: string
                    • Optional sata2?: string
                    • Optional sata3?: string
                    • Optional scsi0?: string
                    • Optional scsi1?: string
                    • Optional scsi2?: string
                    • Optional scsi3?: string
                    • Optional scsihw?: Tscsihw
                    • Optional searchdomain?: string
                    • Optional serial0?: string
                    • Optional serial1?: string
                    • Optional serial2?: string
                    • Optional serial3?: string
                    • Optional shares?: number
                    • Optional skiplock?: boolean
                    • Optional smbios1?: string
                    • Optional smp?: number
                    • Optional sockets?: number
                    • Optional spice_enhancements?: string
                    • Optional sshkeys?: string
                    • Optional startdate?: string
                    • Optional startup?: string
                    • Optional tablet?: boolean
                    • Optional tags?: string
                    • Optional tdf?: boolean
                    • Optional template?: boolean
                    • Optional tpmstate0?: string
                    • Optional unused0?: string
                    • Optional unused1?: string
                    • Optional unused2?: string
                    • Optional unused3?: string
                    • Optional usb0?: string
                    • Optional usb1?: string
                    • Optional usb2?: string
                    • Optional usb3?: string
                    • Optional vcpus?: number
                    • Optional vga?: string
                    • Optional virtio0?: string
                    • Optional virtio1?: string
                    • Optional virtio2?: string
                    • Optional virtio3?: string
                    • Optional vmgenid?: string
                    • Optional vmstatestorage?: string
                    • Optional watchdog?: string

                  Returns Promise<string>

              • $put:function
                • $put(param?: { acpi?: boolean; agent?: string; arch?: Tarch; args?: string; audio0?: string; autostart?: boolean; balloon?: number; bios?: Tbios; boot?: string; bootdisk?: string; cdrom?: string; cicustom?: string; cipassword?: string; citype?: Tcitype; ciuser?: string; cores?: number; cpu?: string; cpulimit?: number; cpuunits?: number; delete?: string; description?: string; digest?: string; efidisk0?: string; force?: boolean; freeze?: boolean; hookscript?: string; hostpci0?: string; hostpci1?: string; hostpci2?: string; hostpci3?: string; hostpci4?: string; hostpci5?: string; hostpci6?: string; hostpci7?: string; hotplug?: string; hugepages?: Thugepages; ide0?: string; ide1?: string; ide2?: string; ide3?: string; ipconfig0?: string; ipconfig1?: string; ipconfig2?: string; ipconfig3?: string; ipconfig4?: string; ipconfig5?: string; ipconfig6?: string; ipconfig7?: string; ivshmem?: string; keephugepages?: boolean; keyboard?: Tkeyboard; kvm?: boolean; localtime?: boolean; lock?: Tlock; machine?: string; memory?: number; migrate_downtime?: number; migrate_speed?: number; name?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; numa?: boolean; numa0?: string; numa1?: string; numa2?: string; numa3?: string; onboot?: boolean; ostype?: Tostype; parallel0?: string; parallel1?: string; parallel2?: string; parallel3?: string; protection?: boolean; reboot?: boolean; revert?: string; rng0?: string; sata0?: string; sata1?: string; sata2?: string; sata3?: string; scsi0?: string; scsi1?: string; scsi2?: string; scsi3?: string; scsihw?: Tscsihw; searchdomain?: string; serial0?: string; serial1?: string; serial2?: string; serial3?: string; shares?: number; skiplock?: boolean; smbios1?: string; smp?: number; sockets?: number; spice_enhancements?: string; sshkeys?: string; startdate?: string; startup?: string; tablet?: boolean; tags?: string; tdf?: boolean; template?: boolean; tpmstate0?: string; unused0?: string; unused1?: string; unused2?: string; unused3?: string; usb0?: string; usb1?: string; usb2?: string; usb3?: string; vcpus?: number; vga?: string; virtio0?: string; virtio1?: string; virtio2?: string; virtio3?: string; vmgenid?: string; vmstatestorage?: string; watchdog?: string }): Promise<null>

                • Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. PUT /nodes/{node}/qemu/{vmid}/config

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { acpi?: boolean; agent?: string; arch?: Tarch; args?: string; audio0?: string; autostart?: boolean; balloon?: number; bios?: Tbios; boot?: string; bootdisk?: string; cdrom?: string; cicustom?: string; cipassword?: string; citype?: Tcitype; ciuser?: string; cores?: number; cpu?: string; cpulimit?: number; cpuunits?: number; delete?: string; description?: string; digest?: string; efidisk0?: string; force?: boolean; freeze?: boolean; hookscript?: string; hostpci0?: string; hostpci1?: string; hostpci2?: string; hostpci3?: string; hostpci4?: string; hostpci5?: string; hostpci6?: string; hostpci7?: string; hotplug?: string; hugepages?: Thugepages; ide0?: string; ide1?: string; ide2?: string; ide3?: string; ipconfig0?: string; ipconfig1?: string; ipconfig2?: string; ipconfig3?: string; ipconfig4?: string; ipconfig5?: string; ipconfig6?: string; ipconfig7?: string; ivshmem?: string; keephugepages?: boolean; keyboard?: Tkeyboard; kvm?: boolean; localtime?: boolean; lock?: Tlock; machine?: string; memory?: number; migrate_downtime?: number; migrate_speed?: number; name?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; numa?: boolean; numa0?: string; numa1?: string; numa2?: string; numa3?: string; onboot?: boolean; ostype?: Tostype; parallel0?: string; parallel1?: string; parallel2?: string; parallel3?: string; protection?: boolean; reboot?: boolean; revert?: string; rng0?: string; sata0?: string; sata1?: string; sata2?: string; sata3?: string; scsi0?: string; scsi1?: string; scsi2?: string; scsi3?: string; scsihw?: Tscsihw; searchdomain?: string; serial0?: string; serial1?: string; serial2?: string; serial3?: string; shares?: number; skiplock?: boolean; smbios1?: string; smp?: number; sockets?: number; spice_enhancements?: string; sshkeys?: string; startdate?: string; startup?: string; tablet?: boolean; tags?: string; tdf?: boolean; template?: boolean; tpmstate0?: string; unused0?: string; unused1?: string; unused2?: string; unused3?: string; usb0?: string; usb1?: string; usb2?: string; usb3?: string; vcpus?: number; vga?: string; virtio0?: string; virtio1?: string; virtio2?: string; virtio3?: string; vmgenid?: string; vmstatestorage?: string; watchdog?: string }
                    • Optional acpi?: boolean
                    • Optional agent?: string
                    • Optional arch?: Tarch
                    • Optional args?: string
                    • Optional audio0?: string
                    • Optional autostart?: boolean
                    • Optional balloon?: number
                    • Optional bios?: Tbios
                    • Optional boot?: string
                    • Optional bootdisk?: string
                    • Optional cdrom?: string
                    • Optional cicustom?: string
                    • Optional cipassword?: string
                    • Optional citype?: Tcitype
                    • Optional ciuser?: string
                    • Optional cores?: number
                    • Optional cpu?: string
                    • Optional cpulimit?: number
                    • Optional cpuunits?: number
                    • Optional delete?: string
                    • Optional description?: string
                    • Optional digest?: string
                    • Optional efidisk0?: string
                    • Optional force?: boolean
                    • Optional freeze?: boolean
                    • Optional hookscript?: string
                    • Optional hostpci0?: string
                    • Optional hostpci1?: string
                    • Optional hostpci2?: string
                    • Optional hostpci3?: string
                    • Optional hostpci4?: string
                    • Optional hostpci5?: string
                    • Optional hostpci6?: string
                    • Optional hostpci7?: string
                    • Optional hotplug?: string
                    • Optional hugepages?: Thugepages
                    • Optional ide0?: string
                    • Optional ide1?: string
                    • Optional ide2?: string
                    • Optional ide3?: string
                    • Optional ipconfig0?: string
                    • Optional ipconfig1?: string
                    • Optional ipconfig2?: string
                    • Optional ipconfig3?: string
                    • Optional ipconfig4?: string
                    • Optional ipconfig5?: string
                    • Optional ipconfig6?: string
                    • Optional ipconfig7?: string
                    • Optional ivshmem?: string
                    • Optional keephugepages?: boolean
                    • Optional keyboard?: Tkeyboard
                    • Optional kvm?: boolean
                    • Optional localtime?: boolean
                    • Optional lock?: Tlock
                    • Optional machine?: string
                    • Optional memory?: number
                    • Optional migrate_downtime?: number
                    • Optional migrate_speed?: number
                    • Optional name?: string
                    • Optional nameserver?: string
                    • Optional net0?: string
                    • Optional net1?: string
                    • Optional net2?: string
                    • Optional net3?: string
                    • Optional numa?: boolean
                    • Optional numa0?: string
                    • Optional numa1?: string
                    • Optional numa2?: string
                    • Optional numa3?: string
                    • Optional onboot?: boolean
                    • Optional ostype?: Tostype
                    • Optional parallel0?: string
                    • Optional parallel1?: string
                    • Optional parallel2?: string
                    • Optional parallel3?: string
                    • Optional protection?: boolean
                    • Optional reboot?: boolean
                    • Optional revert?: string
                    • Optional rng0?: string
                    • Optional sata0?: string
                    • Optional sata1?: string
                    • Optional sata2?: string
                    • Optional sata3?: string
                    • Optional scsi0?: string
                    • Optional scsi1?: string
                    • Optional scsi2?: string
                    • Optional scsi3?: string
                    • Optional scsihw?: Tscsihw
                    • Optional searchdomain?: string
                    • Optional serial0?: string
                    • Optional serial1?: string
                    • Optional serial2?: string
                    • Optional serial3?: string
                    • Optional shares?: number
                    • Optional skiplock?: boolean
                    • Optional smbios1?: string
                    • Optional smp?: number
                    • Optional sockets?: number
                    • Optional spice_enhancements?: string
                    • Optional sshkeys?: string
                    • Optional startdate?: string
                    • Optional startup?: string
                    • Optional tablet?: boolean
                    • Optional tags?: string
                    • Optional tdf?: boolean
                    • Optional template?: boolean
                    • Optional tpmstate0?: string
                    • Optional unused0?: string
                    • Optional unused1?: string
                    • Optional unused2?: string
                    • Optional unused3?: string
                    • Optional usb0?: string
                    • Optional usb1?: string
                    • Optional usb2?: string
                    • Optional usb3?: string
                    • Optional vcpus?: number
                    • Optional vga?: string
                    • Optional virtio0?: string
                    • Optional virtio1?: string
                    • Optional virtio2?: string
                    • Optional virtio3?: string
                    • Optional vmgenid?: string
                    • Optional vmstatestorage?: string
                    • Optional watchdog?: string

                  Returns Promise<null>

            • feature: { $get: any }
            • firewall: { aliases: { $: any; $get: any; $post: any }; ipset: { $: any; $get: any; $post: any }; log: { $get: any }; options: { $get: any; $put: any }; refs: { $get: any }; rules: { $: any; $get: any; $post: any }; $get: any }
              • aliases: { $: any; $get: any; $post: any }
                • $:function
                  • $(name: string): { $delete: any; $get: any; $put: any }

                  • Parameters

                    • name: string

                    Returns { $delete: any; $get: any; $put: any }

                    • $delete:function
                      • $delete(param?: { digest?: string }): Promise<null>

                      • Remove IP or Network alias. DELETE /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { digest?: string }
                          • Optional digest?: string

                        Returns Promise<null>

                    • $get:function
                      • $get(): Promise<any>

                      • Read alias. GET /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<any>

                    • $put:function
                      • $put(param: { cidr: string; comment?: string; digest?: string; rename?: string }): Promise<null>

                      • Update IP or Network alias. PUT /nodes/{node}/qemu/{vmid}/firewall/aliases/{name}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • param: { cidr: string; comment?: string; digest?: string; rename?: string }
                          • cidr: string
                          • Optional comment?: string
                          • Optional digest?: string
                          • Optional rename?: string

                        Returns Promise<null>

                • $get:function
                • $post:function
                  • $post(param: { cidr: string; comment?: string; name: string }): Promise<null>

                  • Create IP or Network Alias. POST /nodes/{node}/qemu/{vmid}/firewall/aliases

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { cidr: string; comment?: string; name: string }
                      • cidr: string
                      • Optional comment?: string
                      • name: string

                    Returns Promise<null>

              • ipset: { $: any; $get: any; $post: any }
                • $:function
                  • $(name: string): { $: any; $delete: any; $get: any; $post: any }

                  • Parameters

                    • name: string

                    Returns { $: any; $delete: any; $get: any; $post: any }

                    • $:function
                      • $(cidr: string): { $delete: any; $get: any; $put: any }

                      • Parameters

                        • cidr: string

                        Returns { $delete: any; $get: any; $put: any }

                        • $delete:function
                          • $delete(param?: { digest?: string }): Promise<null>

                          • Remove IP or Network from IPSet. DELETE /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}

                            Allowtoken

                            1

                            Permissions

                            Parameters

                            • Optional param: { digest?: string }
                              • Optional digest?: string

                            Returns Promise<null>

                        • $get:function
                          • $get(): Promise<any>

                          • Read IP or Network settings from IPSet. GET /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}

                            Allowtoken

                            1

                            Permissions

                            Returns Promise<any>

                        • $put:function
                          • $put(param?: { comment?: string; digest?: string; nomatch?: boolean }): Promise<null>

                          • Update IP or Network settings PUT /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}

                            Allowtoken

                            1

                            Permissions

                            Parameters

                            • Optional param: { comment?: string; digest?: string; nomatch?: boolean }
                              • Optional comment?: string
                              • Optional digest?: string
                              • Optional nomatch?: boolean

                            Returns Promise<null>

                    • $delete:function
                      • $delete(): Promise<null>

                      • Delete IPSet DELETE /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<null>

                    • $get:function
                    • $post:function
                      • $post(param: { cidr: string; comment?: string; nomatch?: boolean }): Promise<null>

                      • Add IP or Network to IPSet. POST /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • param: { cidr: string; comment?: string; nomatch?: boolean }
                          • cidr: string
                          • Optional comment?: string
                          • Optional nomatch?: boolean

                        Returns Promise<null>

                • $get:function
                • $post:function
                  • $post(param: { comment?: string; digest?: string; name: string; rename?: string }): Promise<null>

                  • Create new IPSet POST /nodes/{node}/qemu/{vmid}/firewall/ipset

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { comment?: string; digest?: string; name: string; rename?: string }
                      • Optional comment?: string
                      • Optional digest?: string
                      • name: string
                      • Optional rename?: string

                    Returns Promise<null>

              • log: { $get: any }
                • $get:function
                  • $get(param?: { limit?: number; start?: number }): Promise<nodesQemuFirewallLogLog[]>

                  • Read firewall log GET /nodes/{node}/qemu/{vmid}/firewall/log

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { limit?: number; start?: number }
                      • Optional limit?: number
                      • Optional start?: number

                    Returns Promise<nodesQemuFirewallLogLog[]>

              • options: { $get: any; $put: any }
                • $get:function
                • $put:function
                  • $put(param?: { delete?: string; dhcp?: boolean; digest?: string; enable?: boolean; ipfilter?: boolean; log_level_in?: Tlog; log_level_out?: Tlog; macfilter?: boolean; ndp?: boolean; policy_in?: Tpolicy_in; policy_out?: Tpolicy_in; radv?: boolean }): Promise<null>

                  • Set Firewall options. PUT /nodes/{node}/qemu/{vmid}/firewall/options

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { delete?: string; dhcp?: boolean; digest?: string; enable?: boolean; ipfilter?: boolean; log_level_in?: Tlog; log_level_out?: Tlog; macfilter?: boolean; ndp?: boolean; policy_in?: Tpolicy_in; policy_out?: Tpolicy_in; radv?: boolean }
                      • Optional delete?: string
                      • Optional dhcp?: boolean
                      • Optional digest?: string
                      • Optional enable?: boolean
                      • Optional ipfilter?: boolean
                      • Optional log_level_in?: Tlog
                      • Optional log_level_out?: Tlog
                      • Optional macfilter?: boolean
                      • Optional ndp?: boolean
                      • Optional policy_in?: Tpolicy_in
                      • Optional policy_out?: Tpolicy_in
                      • Optional radv?: boolean

                    Returns Promise<null>

              • refs: { $get: any }
              • rules: { $: any; $get: any; $post: any }
                • $:function
                  • $(pos: string): { $delete: any; $get: any; $put: any }

                  • Parameters

                    • pos: string

                    Returns { $delete: any; $get: any; $put: any }

                    • $delete:function
                      • $delete(param?: { digest?: string }): Promise<null>

                      • Delete rule. DELETE /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { digest?: string }
                          • Optional digest?: string

                        Returns Promise<null>

                    • $get:function
                    • $put:function
                      • $put(param?: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }): Promise<null>

                      • Modify rule data. PUT /nodes/{node}/qemu/{vmid}/firewall/rules/{pos}

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { action?: string; comment?: string; delete?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; moveto?: number; proto?: string; source?: string; sport?: string; type?: Ttype_1 }
                          • Optional action?: string
                          • Optional comment?: string
                          • Optional delete?: string
                          • Optional dest?: string
                          • Optional digest?: string
                          • Optional dport?: string
                          • Optional enable?: number
                          • Optional icmp-type?: string
                          • Optional iface?: string
                          • Optional log?: Tlog
                          • Optional macro?: string
                          • Optional moveto?: number
                          • Optional proto?: string
                          • Optional source?: string
                          • Optional sport?: string
                          • Optional type?: Ttype_1

                        Returns Promise<null>

                • $get:function
                • $post:function
                  • $post(param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }): Promise<null>

                  • Create new rule. POST /nodes/{node}/qemu/{vmid}/firewall/rules

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { action: string; comment?: string; dest?: string; digest?: string; dport?: string; enable?: number; icmp-type?: string; iface?: string; log?: Tlog; macro?: string; pos?: number; proto?: string; source?: string; sport?: string; type: Ttype_1 }
                      • action: string
                      • Optional comment?: string
                      • Optional dest?: string
                      • Optional digest?: string
                      • Optional dport?: string
                      • Optional enable?: number
                      • Optional icmp-type?: string
                      • Optional iface?: string
                      • Optional log?: Tlog
                      • Optional macro?: string
                      • Optional pos?: number
                      • Optional proto?: string
                      • Optional source?: string
                      • Optional sport?: string
                      • type: Ttype_1

                    Returns Promise<null>

              • $get:function
            • migrate: { $get: any; $post: any }
              • $get:function
              • $post:function
                • $post(param: { bwlimit?: number; force?: boolean; migration_network?: string; migration_type?: Tmigration_type; online?: boolean; target: string; targetstorage?: string; with-local-disks?: boolean }): Promise<string>

                • Migrate virtual machine. Creates a new migration task. POST /nodes/{node}/qemu/{vmid}/migrate

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { bwlimit?: number; force?: boolean; migration_network?: string; migration_type?: Tmigration_type; online?: boolean; target: string; targetstorage?: string; with-local-disks?: boolean }
                    • Optional bwlimit?: number
                    • Optional force?: boolean
                    • Optional migration_network?: string
                    • Optional migration_type?: Tmigration_type
                    • Optional online?: boolean
                    • target: string
                    • Optional targetstorage?: string
                    • Optional with-local-disks?: boolean

                  Returns Promise<string>

            • monitor: { $post: any }
              • $post:function
                • $post(param: { command: string }): Promise<string>

                • Execute Qemu monitor commands. POST /nodes/{node}/qemu/{vmid}/monitor

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { command: string }
                    • command: string

                  Returns Promise<string>

            • move_disk: { $post: any }
              • $post:function
                • $post(param: { bwlimit?: number; delete?: boolean; digest?: string; disk: Tdisk; format?: Tformat; storage?: string; target-digest?: string; target-disk?: Tdisk; target-vmid?: number }): Promise<string>

                • Move volume to different storage or to a different VM. POST /nodes/{node}/qemu/{vmid}/move_disk

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { bwlimit?: number; delete?: boolean; digest?: string; disk: Tdisk; format?: Tformat; storage?: string; target-digest?: string; target-disk?: Tdisk; target-vmid?: number }
                    • Optional bwlimit?: number
                    • Optional delete?: boolean
                    • Optional digest?: string
                    • disk: Tdisk
                    • Optional format?: Tformat
                    • Optional storage?: string
                    • Optional target-digest?: string
                    • Optional target-disk?: Tdisk
                    • Optional target-vmid?: number

                  Returns Promise<string>

            • pending: { $get: any }
            • resize: { $put: any }
              • $put:function
                • $put(param: { digest?: string; disk: Tdisk_1; size: string; skiplock?: boolean }): Promise<null>

                • Extend volume size. PUT /nodes/{node}/qemu/{vmid}/resize

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { digest?: string; disk: Tdisk_1; size: string; skiplock?: boolean }
                    • Optional digest?: string
                    • disk: Tdisk_1
                    • size: string
                    • Optional skiplock?: boolean

                  Returns Promise<null>

            • rrd: { $get: any }
            • rrddata: { $get: any }
            • sendkey: { $put: any }
              • $put:function
                • $put(param: { key: string; skiplock?: boolean }): Promise<null>

                • Send key event to virtual machine. PUT /nodes/{node}/qemu/{vmid}/sendkey

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { key: string; skiplock?: boolean }
                    • key: string
                    • Optional skiplock?: boolean

                  Returns Promise<null>

            • snapshot: { $: any; $get: any; $post: any }
              • $:function
                • $(snapname: string): { config: { $get: any; $put: any }; rollback: { $post: any }; $delete: any; $get: any }

                • Parameters

                  • snapname: string

                  Returns { config: { $get: any; $put: any }; rollback: { $post: any }; $delete: any; $get: any }

                  • config: { $get: any; $put: any }
                    • $get:function
                      • $get(): Promise<any>

                      • Get snapshot configuration GET /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<any>

                    • $put:function
                      • $put(param?: { description?: string }): Promise<null>

                      • Update snapshot metadata. PUT /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config

                        Allowtoken

                        1

                        Permissions

                        Parameters

                        • Optional param: { description?: string }
                          • Optional description?: string

                        Returns Promise<null>

                  • rollback: { $post: any }
                    • $post:function
                      • $post(): Promise<string>

                      • Rollback VM state to specified snapshot. POST /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback

                        Allowtoken

                        1

                        Permissions

                        Returns Promise<string>

                  • $delete:function
                    • $delete(param?: { force?: boolean }): Promise<string>

                    • Delete a VM snapshot. DELETE /nodes/{node}/qemu/{vmid}/snapshot/{snapname}

                      Allowtoken

                      1

                      Permissions

                      Parameters

                      • Optional param: { force?: boolean }
                        • Optional force?: boolean

                      Returns Promise<string>

                  • $get:function
              • $get:function
              • $post:function
                • $post(param: { description?: string; snapname: string; vmstate?: boolean }): Promise<string>

                • Snapshot a VM. POST /nodes/{node}/qemu/{vmid}/snapshot

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { description?: string; snapname: string; vmstate?: boolean }
                    • Optional description?: string
                    • snapname: string
                    • Optional vmstate?: boolean

                  Returns Promise<string>

            • spiceproxy: { $post: any }
            • status: { current: { $get: any }; reboot: { $post: any }; reset: { $post: any }; resume: { $post: any }; shutdown: { $post: any }; start: { $post: any }; stop: { $post: any }; suspend: { $post: any }; $get: any }
              • current: { $get: any }
              • reboot: { $post: any }
                • $post:function
                  • $post(param?: { timeout?: number }): Promise<string>

                  • Reboot the VM by shutting it down, and starting it again. Applies pending changes. POST /nodes/{node}/qemu/{vmid}/status/reboot

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { timeout?: number }
                      • Optional timeout?: number

                    Returns Promise<string>

              • reset: { $post: any }
                • $post:function
                  • $post(param?: { skiplock?: boolean }): Promise<string>

                  • Reset virtual machine. POST /nodes/{node}/qemu/{vmid}/status/reset

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { skiplock?: boolean }
                      • Optional skiplock?: boolean

                    Returns Promise<string>

              • resume: { $post: any }
                • $post:function
                  • $post(param?: { nocheck?: boolean; skiplock?: boolean }): Promise<string>

                  • Resume virtual machine. POST /nodes/{node}/qemu/{vmid}/status/resume

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { nocheck?: boolean; skiplock?: boolean }
                      • Optional nocheck?: boolean
                      • Optional skiplock?: boolean

                    Returns Promise<string>

              • shutdown: { $post: any }
                • $post:function
                  • $post(param?: { forceStop?: boolean; keepActive?: boolean; skiplock?: boolean; timeout?: number }): Promise<string>

                  • Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown. POST /nodes/{node}/qemu/{vmid}/status/shutdown

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { forceStop?: boolean; keepActive?: boolean; skiplock?: boolean; timeout?: number }
                      • Optional forceStop?: boolean
                      • Optional keepActive?: boolean
                      • Optional skiplock?: boolean
                      • Optional timeout?: number

                    Returns Promise<string>

              • start: { $post: any }
                • $post:function
                  • $post(param?: { force-cpu?: string; machine?: string; migratedfrom?: string; migration_network?: string; migration_type?: Tmigration_type; skiplock?: boolean; stateuri?: string; targetstorage?: string; timeout?: number }): Promise<string>

                  • Start virtual machine. POST /nodes/{node}/qemu/{vmid}/status/start

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { force-cpu?: string; machine?: string; migratedfrom?: string; migration_network?: string; migration_type?: Tmigration_type; skiplock?: boolean; stateuri?: string; targetstorage?: string; timeout?: number }
                      • Optional force-cpu?: string
                      • Optional machine?: string
                      • Optional migratedfrom?: string
                      • Optional migration_network?: string
                      • Optional migration_type?: Tmigration_type
                      • Optional skiplock?: boolean
                      • Optional stateuri?: string
                      • Optional targetstorage?: string
                      • Optional timeout?: number

                    Returns Promise<string>

              • stop: { $post: any }
                • $post:function
                  • $post(param?: { keepActive?: boolean; migratedfrom?: string; skiplock?: boolean; timeout?: number }): Promise<string>

                  • Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data POST /nodes/{node}/qemu/{vmid}/status/stop

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { keepActive?: boolean; migratedfrom?: string; skiplock?: boolean; timeout?: number }
                      • Optional keepActive?: boolean
                      • Optional migratedfrom?: string
                      • Optional skiplock?: boolean
                      • Optional timeout?: number

                    Returns Promise<string>

              • suspend: { $post: any }
                • $post:function
                  • $post(param?: { skiplock?: boolean; statestorage?: string; todisk?: boolean }): Promise<string>

                  • Suspend virtual machine. POST /nodes/{node}/qemu/{vmid}/status/suspend

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • Optional param: { skiplock?: boolean; statestorage?: string; todisk?: boolean }
                      • Optional skiplock?: boolean
                      • Optional statestorage?: string
                      • Optional todisk?: boolean

                    Returns Promise<string>

              • $get:function
            • template: { $post: any }
              • $post:function
                • $post(param?: { disk?: Tdisk_1 }): Promise<string>

                • Create a Template. POST /nodes/{node}/qemu/{vmid}/template

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  Returns Promise<string>

            • termproxy: { $post: any }
            • unlink: { $put: any }
              • $put:function
                • $put(param: { force?: boolean; idlist: string }): Promise<null>

                • Unlink/delete disk images. PUT /nodes/{node}/qemu/{vmid}/unlink

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { force?: boolean; idlist: string }
                    • Optional force?: boolean
                    • idlist: string

                  Returns Promise<null>

            • vncproxy: { $post: any }
              • $post:function
                • $post(param?: { generate-password?: boolean; websocket?: boolean }): Promise<nodesQemuVncproxyVncproxy>

                • Creates a TCP VNC proxy connections. POST /nodes/{node}/qemu/{vmid}/vncproxy

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { generate-password?: boolean; websocket?: boolean }
                    • Optional generate-password?: boolean
                    • Optional websocket?: boolean

                  Returns Promise<nodesQemuVncproxyVncproxy>

            • vncwebsocket: { $get: any }
            • $delete:function
              • $delete(param?: { destroy-unreferenced-disks?: boolean; purge?: boolean; skiplock?: boolean }): Promise<string>

              • Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules DELETE /nodes/{node}/qemu/{vmid}

                Allowtoken

                1

                Permissions

                Parameters

                • Optional param: { destroy-unreferenced-disks?: boolean; purge?: boolean; skiplock?: boolean }
                  • Optional destroy-unreferenced-disks?: boolean
                  • Optional purge?: boolean
                  • Optional skiplock?: boolean

                Returns Promise<string>

            • $get:function
        • $get:function
          • $get(param?: { full?: boolean }): Promise<nodesQemuVm[]>

          • Virtual machine index (per node). GET /nodes/{node}/qemu

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { full?: boolean }
              • Optional full?: boolean

            Returns Promise<nodesQemuVm[]>

        • $post:function
          • $post(param: { acpi?: boolean; agent?: string; arch?: Tarch; archive?: string; args?: string; audio0?: string; autostart?: boolean; balloon?: number; bios?: Tbios; boot?: string; bootdisk?: string; bwlimit?: number; cdrom?: string; cicustom?: string; cipassword?: string; citype?: Tcitype; ciuser?: string; cores?: number; cpu?: string; cpulimit?: number; cpuunits?: number; description?: string; efidisk0?: string; force?: boolean; freeze?: boolean; hookscript?: string; hostpci0?: string; hostpci1?: string; hostpci2?: string; hostpci3?: string; hostpci4?: string; hostpci5?: string; hostpci6?: string; hostpci7?: string; hotplug?: string; hugepages?: Thugepages; ide0?: string; ide1?: string; ide2?: string; ide3?: string; ipconfig0?: string; ipconfig1?: string; ipconfig2?: string; ipconfig3?: string; ipconfig4?: string; ipconfig5?: string; ipconfig6?: string; ipconfig7?: string; ivshmem?: string; keephugepages?: boolean; keyboard?: Tkeyboard; kvm?: boolean; live-restore?: boolean; localtime?: boolean; lock?: Tlock; machine?: string; memory?: number; migrate_downtime?: number; migrate_speed?: number; name?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; numa?: boolean; numa0?: string; numa1?: string; numa2?: string; numa3?: string; onboot?: boolean; ostype?: Tostype; parallel0?: string; parallel1?: string; parallel2?: string; parallel3?: string; pool?: string; protection?: boolean; reboot?: boolean; rng0?: string; sata0?: string; sata1?: string; sata2?: string; sata3?: string; scsi0?: string; scsi1?: string; scsi2?: string; scsi3?: string; scsihw?: Tscsihw; searchdomain?: string; serial0?: string; serial1?: string; serial2?: string; serial3?: string; shares?: number; smbios1?: string; smp?: number; sockets?: number; spice_enhancements?: string; sshkeys?: string; start?: boolean; startdate?: string; startup?: string; storage?: string; tablet?: boolean; tags?: string; tdf?: boolean; template?: boolean; tpmstate0?: string; unique?: boolean; unused0?: string; unused1?: string; unused2?: string; unused3?: string; usb0?: string; usb1?: string; usb2?: string; usb3?: string; vcpus?: number; vga?: string; virtio0?: string; virtio1?: string; virtio2?: string; virtio3?: string; vmgenid?: string; vmid: number; vmstatestorage?: string; watchdog?: string }): Promise<string>

          • Create or restore a virtual machine. POST /nodes/{node}/qemu

            Allowtoken

            1

            Permissions

            Parameters

            • param: { acpi?: boolean; agent?: string; arch?: Tarch; archive?: string; args?: string; audio0?: string; autostart?: boolean; balloon?: number; bios?: Tbios; boot?: string; bootdisk?: string; bwlimit?: number; cdrom?: string; cicustom?: string; cipassword?: string; citype?: Tcitype; ciuser?: string; cores?: number; cpu?: string; cpulimit?: number; cpuunits?: number; description?: string; efidisk0?: string; force?: boolean; freeze?: boolean; hookscript?: string; hostpci0?: string; hostpci1?: string; hostpci2?: string; hostpci3?: string; hostpci4?: string; hostpci5?: string; hostpci6?: string; hostpci7?: string; hotplug?: string; hugepages?: Thugepages; ide0?: string; ide1?: string; ide2?: string; ide3?: string; ipconfig0?: string; ipconfig1?: string; ipconfig2?: string; ipconfig3?: string; ipconfig4?: string; ipconfig5?: string; ipconfig6?: string; ipconfig7?: string; ivshmem?: string; keephugepages?: boolean; keyboard?: Tkeyboard; kvm?: boolean; live-restore?: boolean; localtime?: boolean; lock?: Tlock; machine?: string; memory?: number; migrate_downtime?: number; migrate_speed?: number; name?: string; nameserver?: string; net0?: string; net1?: string; net2?: string; net3?: string; numa?: boolean; numa0?: string; numa1?: string; numa2?: string; numa3?: string; onboot?: boolean; ostype?: Tostype; parallel0?: string; parallel1?: string; parallel2?: string; parallel3?: string; pool?: string; protection?: boolean; reboot?: boolean; rng0?: string; sata0?: string; sata1?: string; sata2?: string; sata3?: string; scsi0?: string; scsi1?: string; scsi2?: string; scsi3?: string; scsihw?: Tscsihw; searchdomain?: string; serial0?: string; serial1?: string; serial2?: string; serial3?: string; shares?: number; smbios1?: string; smp?: number; sockets?: number; spice_enhancements?: string; sshkeys?: string; start?: boolean; startdate?: string; startup?: string; storage?: string; tablet?: boolean; tags?: string; tdf?: boolean; template?: boolean; tpmstate0?: string; unique?: boolean; unused0?: string; unused1?: string; unused2?: string; unused3?: string; usb0?: string; usb1?: string; usb2?: string; usb3?: string; vcpus?: number; vga?: string; virtio0?: string; virtio1?: string; virtio2?: string; virtio3?: string; vmgenid?: string; vmid: number; vmstatestorage?: string; watchdog?: string }
              • Optional acpi?: boolean
              • Optional agent?: string
              • Optional arch?: Tarch
              • Optional archive?: string
              • Optional args?: string
              • Optional audio0?: string
              • Optional autostart?: boolean
              • Optional balloon?: number
              • Optional bios?: Tbios
              • Optional boot?: string
              • Optional bootdisk?: string
              • Optional bwlimit?: number
              • Optional cdrom?: string
              • Optional cicustom?: string
              • Optional cipassword?: string
              • Optional citype?: Tcitype
              • Optional ciuser?: string
              • Optional cores?: number
              • Optional cpu?: string
              • Optional cpulimit?: number
              • Optional cpuunits?: number
              • Optional description?: string
              • Optional efidisk0?: string
              • Optional force?: boolean
              • Optional freeze?: boolean
              • Optional hookscript?: string
              • Optional hostpci0?: string
              • Optional hostpci1?: string
              • Optional hostpci2?: string
              • Optional hostpci3?: string
              • Optional hostpci4?: string
              • Optional hostpci5?: string
              • Optional hostpci6?: string
              • Optional hostpci7?: string
              • Optional hotplug?: string
              • Optional hugepages?: Thugepages
              • Optional ide0?: string
              • Optional ide1?: string
              • Optional ide2?: string
              • Optional ide3?: string
              • Optional ipconfig0?: string
              • Optional ipconfig1?: string
              • Optional ipconfig2?: string
              • Optional ipconfig3?: string
              • Optional ipconfig4?: string
              • Optional ipconfig5?: string
              • Optional ipconfig6?: string
              • Optional ipconfig7?: string
              • Optional ivshmem?: string
              • Optional keephugepages?: boolean
              • Optional keyboard?: Tkeyboard
              • Optional kvm?: boolean
              • Optional live-restore?: boolean
              • Optional localtime?: boolean
              • Optional lock?: Tlock
              • Optional machine?: string
              • Optional memory?: number
              • Optional migrate_downtime?: number
              • Optional migrate_speed?: number
              • Optional name?: string
              • Optional nameserver?: string
              • Optional net0?: string
              • Optional net1?: string
              • Optional net2?: string
              • Optional net3?: string
              • Optional numa?: boolean
              • Optional numa0?: string
              • Optional numa1?: string
              • Optional numa2?: string
              • Optional numa3?: string
              • Optional onboot?: boolean
              • Optional ostype?: Tostype
              • Optional parallel0?: string
              • Optional parallel1?: string
              • Optional parallel2?: string
              • Optional parallel3?: string
              • Optional pool?: string
              • Optional protection?: boolean
              • Optional reboot?: boolean
              • Optional rng0?: string
              • Optional sata0?: string
              • Optional sata1?: string
              • Optional sata2?: string
              • Optional sata3?: string
              • Optional scsi0?: string
              • Optional scsi1?: string
              • Optional scsi2?: string
              • Optional scsi3?: string
              • Optional scsihw?: Tscsihw
              • Optional searchdomain?: string
              • Optional serial0?: string
              • Optional serial1?: string
              • Optional serial2?: string
              • Optional serial3?: string
              • Optional shares?: number
              • Optional smbios1?: string
              • Optional smp?: number
              • Optional sockets?: number
              • Optional spice_enhancements?: string
              • Optional sshkeys?: string
              • Optional start?: boolean
              • Optional startdate?: string
              • Optional startup?: string
              • Optional storage?: string
              • Optional tablet?: boolean
              • Optional tags?: string
              • Optional tdf?: boolean
              • Optional template?: boolean
              • Optional tpmstate0?: string
              • Optional unique?: boolean
              • Optional unused0?: string
              • Optional unused1?: string
              • Optional unused2?: string
              • Optional unused3?: string
              • Optional usb0?: string
              • Optional usb1?: string
              • Optional usb2?: string
              • Optional usb3?: string
              • Optional vcpus?: number
              • Optional vga?: string
              • Optional virtio0?: string
              • Optional virtio1?: string
              • Optional virtio2?: string
              • Optional virtio3?: string
              • Optional vmgenid?: string
              • vmid: number
              • Optional vmstatestorage?: string
              • Optional watchdog?: string

            Returns Promise<string>

      • query-url-metadata: { $get: any }
        • $get:function
      • replication: { $: any; $get: any }
        • $:function
          • $(id: string): { log: { $get: any }; schedule_now: { $post: any }; status: { $get: any }; $get: any }

          • Parameters

            • id: string

            Returns { log: { $get: any }; schedule_now: { $post: any }; status: { $get: any }; $get: any }

            • log: { $get: any }
              • $get:function
                • $get(param?: { limit?: number; start?: number }): Promise<nodesReplicationLogReadJobLog[]>

                • Read replication job log. GET /nodes/{node}/replication/{id}/log

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { limit?: number; start?: number }
                    • Optional limit?: number
                    • Optional start?: number

                  Returns Promise<nodesReplicationLogReadJobLog[]>

            • schedule_now: { $post: any }
              • $post:function
                • $post(): Promise<string>

                • Schedule replication job to start as soon as possible. POST /nodes/{node}/replication/{id}/schedule_now

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

            • status: { $get: any }
              • $get:function
                • $get(): Promise<any>

                • Get replication job status. GET /nodes/{node}/replication/{id}/status

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<any>

            • $get:function
        • $get:function
          • $get(param?: { guest?: number }): Promise<nodesReplicationStatus[]>

          • List status of all replication jobs on this node. GET /nodes/{node}/replication

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { guest?: number }
              • Optional guest?: number

            Returns Promise<nodesReplicationStatus[]>

      • report: { $get: any }
        • $get:function
          • $get(): Promise<string>

          • Gather various systems information about a node GET /nodes/{node}/report

            Allowtoken

            1

            Permissions

            Returns Promise<string>

      • rrd: { $get: any }
      • rrddata: { $get: any }
      • scan: { cifs: { $get: any }; glusterfs: { $get: any }; iscsi: { $get: any }; lvm: { $get: any }; lvmthin: { $get: any }; nfs: { $get: any }; pbs: { $get: any }; zfs: { $get: any }; $get: any }
        • cifs: { $get: any }
          • $get:function
            • $get(param: { domain?: string; password?: string; server: string; username?: string }): Promise<nodesScanCifsCifsscan[]>

            • Scan remote CIFS server. GET /nodes/{node}/scan/cifs

              Allowtoken

              1

              Permissions

              Parameters

              • param: { domain?: string; password?: string; server: string; username?: string }
                • Optional domain?: string
                • Optional password?: string
                • server: string
                • Optional username?: string

              Returns Promise<nodesScanCifsCifsscan[]>

        • glusterfs: { $get: any }
        • iscsi: { $get: any }
        • lvm: { $get: any }
        • lvmthin: { $get: any }
        • nfs: { $get: any }
          • $get:function
            • $get(param: { server: string }): Promise<nodesScanNfsNfsscan[]>

            • Scan remote NFS server. GET /nodes/{node}/scan/nfs

              Allowtoken

              1

              Permissions

              Parameters

              • param: { server: string }
                • server: string

              Returns Promise<nodesScanNfsNfsscan[]>

        • pbs: { $get: any }
          • $get:function
            • $get(param: { fingerprint?: string; password: string; port?: number; server: string; username: string }): Promise<nodesScanPbsPbsscan[]>

            • Scan remote Proxmox Backup Server. GET /nodes/{node}/scan/pbs

              Allowtoken

              1

              Permissions

              Parameters

              • param: { fingerprint?: string; password: string; port?: number; server: string; username: string }
                • Optional fingerprint?: string
                • password: string
                • Optional port?: number
                • server: string
                • username: string

              Returns Promise<nodesScanPbsPbsscan[]>

        • zfs: { $get: any }
        • $get:function
      • sdn: { zones: { $: any; $get: any }; $get: any }
      • services: { $: any; $get: any }
        • $:function
          • $(service: string): { reload: { $post: any }; restart: { $post: any }; start: { $post: any }; state: { $get: any }; stop: { $post: any }; $get: any }

          • Parameters

            • service: string

            Returns { reload: { $post: any }; restart: { $post: any }; start: { $post: any }; state: { $get: any }; stop: { $post: any }; $get: any }

            • reload: { $post: any }
              • $post:function
                • $post(): Promise<string>

                • Reload service. Falls back to restart if service cannot be reloaded. POST /nodes/{node}/services/{service}/reload

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

            • restart: { $post: any }
              • $post:function
                • $post(): Promise<string>

                • Hard restart service. Use reload if you want to reduce interruptions. POST /nodes/{node}/services/{service}/restart

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

            • start: { $post: any }
              • $post:function
                • $post(): Promise<string>

                • Start service. POST /nodes/{node}/services/{service}/start

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

            • state: { $get: any }
              • $get:function
                • $get(): Promise<any>

                • Read service properties GET /nodes/{node}/services/{service}/state

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<any>

            • stop: { $post: any }
              • $post:function
                • $post(): Promise<string>

                • Stop service. POST /nodes/{node}/services/{service}/stop

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<string>

            • $get:function
        • $get:function
      • spiceshell: { $post: any }
        • $post:function
          • $post(param?: { cmd?: Tcmd; cmd-opts?: string; proxy?: string }): Promise<nodesSpiceshellSpiceshell>

          • Creates a SPICE shell. POST /nodes/{node}/spiceshell

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { cmd?: Tcmd; cmd-opts?: string; proxy?: string }
              • Optional cmd?: Tcmd
              • Optional cmd-opts?: string
              • Optional proxy?: string

            Returns Promise<nodesSpiceshellSpiceshell>

      • startall: { $post: any }
        • $post:function
          • $post(param?: { force?: boolean; vms?: string }): Promise<string>

          • Start all VMs and containers located on this node (by default only those with onboot=1). POST /nodes/{node}/startall

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { force?: boolean; vms?: string }
              • Optional force?: boolean
              • Optional vms?: string

            Returns Promise<string>

      • status: { $get: any; $post: any }
        • $get:function
          • $get(): Promise<any>

          • Read node status GET /nodes/{node}/status

            Allowtoken

            1

            Permissions

            Returns Promise<any>

        • $post:function
          • $post(param: { command: Tcommand_1 }): Promise<null>

          • Reboot or shutdown a node. POST /nodes/{node}/status

            Allowtoken

            1

            Permissions

            Parameters

            Returns Promise<null>

      • stopall: { $post: any }
        • $post:function
          • $post(param?: { vms?: string }): Promise<string>

          • Stop all VMs and Containers. POST /nodes/{node}/stopall

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { vms?: string }
              • Optional vms?: string

            Returns Promise<string>

      • storage: { $: any; $get: any }
        • $:function
          • $(storage: string): { content: { $: any; $get: any; $post: any }; download-url: { $post: any }; file-restore: { download: { $get: any }; list: { $get: any } }; prunebackups: { $delete: any; $get: any }; rrd: { $get: any }; rrddata: { $get: any }; status: { $get: any }; upload: { $post: any }; $get: any }

          • Parameters

            • storage: string

            Returns { content: { $: any; $get: any; $post: any }; download-url: { $post: any }; file-restore: { download: { $get: any }; list: { $get: any } }; prunebackups: { $delete: any; $get: any }; rrd: { $get: any }; rrddata: { $get: any }; status: { $get: any }; upload: { $post: any }; $get: any }

            • content: { $: any; $get: any; $post: any }
              • $:function
                • $(volume: string): { $delete: any; $get: any; $post: any; $put: any }

                • Parameters

                  • volume: string

                  Returns { $delete: any; $get: any; $post: any; $put: any }

                  • $delete:function
                    • $delete(param?: { delay?: number }): Promise<string>

                    • Delete volume DELETE /nodes/{node}/storage/{storage}/content/{volume}

                      Allowtoken

                      1

                      Permissions

                      Parameters

                      • Optional param: { delay?: number }
                        • Optional delay?: number

                      Returns Promise<string>

                  • $get:function
                  • $post:function
                    • $post(param: { target: string; target_node?: string }): Promise<string>

                    • Copy a volume. This is experimental code - do not use. POST /nodes/{node}/storage/{storage}/content/{volume}

                      Allowtoken

                      1

                      Parameters

                      • param: { target: string; target_node?: string }
                        • target: string
                        • Optional target_node?: string

                      Returns Promise<string>

                  • $put:function
                    • $put(param?: { notes?: string; protected?: boolean }): Promise<null>

                    • Update volume attributes PUT /nodes/{node}/storage/{storage}/content/{volume}

                      Allowtoken

                      1

                      Permissions

                      Parameters

                      • Optional param: { notes?: string; protected?: boolean }
                        • Optional notes?: string
                        • Optional protected?: boolean

                      Returns Promise<null>

              • $get:function
                • $get(param?: { content?: string; vmid?: number }): Promise<nodesStorageContentIndex[]>

                • List storage content. GET /nodes/{node}/storage/{storage}/content

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { content?: string; vmid?: number }
                    • Optional content?: string
                    • Optional vmid?: number

                  Returns Promise<nodesStorageContentIndex[]>

              • $post:function
                • $post(param: { filename: string; format?: Tformat_1; size: string; vmid: number }): Promise<string>

                • Allocate disk images. POST /nodes/{node}/storage/{storage}/content

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • param: { filename: string; format?: Tformat_1; size: string; vmid: number }
                    • filename: string
                    • Optional format?: Tformat_1
                    • size: string
                    • vmid: number

                  Returns Promise<string>

            • download-url: { $post: any }
              • $post:function
                • $post(param: { checksum?: string; checksum-algorithm?: Tchecksumalgorithm; content: pvestoragecontent_1; filename: string; url: string; verify-certificates?: boolean }): Promise<string>

                • Download templates and ISO images by using an URL. POST /nodes/{node}/storage/{storage}/download-url

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  Returns Promise<string>

            • file-restore: { download: { $get: any }; list: { $get: any } }
              • download: { $get: any }
                • $get:function
                  • $get(param: { filepath: string; volume: string }): Promise<any>

                  • Extract a file or directory (as zip archive) from a PBS backup. GET /nodes/{node}/storage/{storage}/file-restore/download

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { filepath: string; volume: string }
                      • filepath: string
                      • volume: string

                    Returns Promise<any>

              • list: { $get: any }
                • $get:function
                  • $get(param: { filepath: string; volume: string }): Promise<nodesStorageFileRestoreListList[]>

                  • List files and directories for single file restore under the given path. GET /nodes/{node}/storage/{storage}/file-restore/list

                    Allowtoken

                    1

                    Permissions

                    Parameters

                    • param: { filepath: string; volume: string }
                      • filepath: string
                      • volume: string

                    Returns Promise<nodesStorageFileRestoreListList[]>

            • prunebackups: { $delete: any; $get: any }
              • $delete:function
                • $delete(param?: { prune-backups?: string; type?: Ttype_16; vmid?: number }): Promise<string>

                • Prune backups. Only those using the standard naming scheme are considered. DELETE /nodes/{node}/storage/{storage}/prunebackups

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { prune-backups?: string; type?: Ttype_16; vmid?: number }
                    • Optional prune-backups?: string
                    • Optional type?: Ttype_16
                    • Optional vmid?: number

                  Returns Promise<string>

              • $get:function
                • $get(param?: { prune-backups?: string; type?: Ttype_16; vmid?: number }): Promise<nodesStoragePrunebackupsDryrun[]>

                • Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime. GET /nodes/{node}/storage/{storage}/prunebackups

                  Allowtoken

                  1

                  Permissions

                  Parameters

                  • Optional param: { prune-backups?: string; type?: Ttype_16; vmid?: number }
                    • Optional prune-backups?: string
                    • Optional type?: Ttype_16
                    • Optional vmid?: number

                  Returns Promise<nodesStoragePrunebackupsDryrun[]>

            • rrd: { $get: any }
            • rrddata: { $get: any }
            • status: { $get: any }
              • $get:function
                • $get(): Promise<any>

                • Read storage status. GET /nodes/{node}/storage/{storage}/status

                  Allowtoken

                  1

                  Permissions

                  Returns Promise<any>

            • upload: { $post: any }
              • $post:function
            • $get:function
        • $get:function
          • $get(param?: { content?: string; enabled?: boolean; format?: boolean; storage?: string; target?: string }): Promise<nodesStorageIndex[]>

          • Get status for all datastores. GET /nodes/{node}/storage

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { content?: string; enabled?: boolean; format?: boolean; storage?: string; target?: string }
              • Optional content?: string
              • Optional enabled?: boolean
              • Optional format?: boolean
              • Optional storage?: string
              • Optional target?: string

            Returns Promise<nodesStorageIndex[]>

      • subscription: { $delete: any; $get: any; $post: any; $put: any }
        • $delete:function
          • $delete(): Promise<null>

          • Delete subscription key of this node. DELETE /nodes/{node}/subscription

            Allowtoken

            1

            Permissions

            Returns Promise<null>

        • $get:function
          • $get(): Promise<any>

          • Read subscription info. GET /nodes/{node}/subscription

            Allowtoken

            1

            Permissions

            Returns Promise<any>

        • $post:function
          • $post(param?: { force?: boolean }): Promise<null>

          • Update subscription info. POST /nodes/{node}/subscription

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { force?: boolean }
              • Optional force?: boolean

            Returns Promise<null>

        • $put:function
          • $put(param: { key: string }): Promise<null>

          • Set subscription key. PUT /nodes/{node}/subscription

            Allowtoken

            1

            Permissions

            Parameters

            • param: { key: string }
              • key: string

            Returns Promise<null>

      • syslog: { $get: any }
        • $get:function
          • $get(param?: { limit?: number; service?: string; since?: string; start?: number; until?: string }): Promise<nodesSyslogSyslog[]>

          • Read system log GET /nodes/{node}/syslog

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { limit?: number; service?: string; since?: string; start?: number; until?: string }
              • Optional limit?: number
              • Optional service?: string
              • Optional since?: string
              • Optional start?: number
              • Optional until?: string

            Returns Promise<nodesSyslogSyslog[]>

      • tasks: { $: any; $get: any }
        • $:function
          • $(upid: string): { log: { $get: any }; status: { $get: any }; $delete: any; $get: any }

          • Parameters

            • upid: string

            Returns { log: { $get: any }; status: { $get: any }; $delete: any; $get: any }

        • $get:function
          • $get(param?: { errors?: boolean; limit?: number; since?: number; source?: Tsource; start?: number; statusfilter?: string; typefilter?: string; until?: number; userfilter?: string; vmid?: number }): Promise<nodesTasksNodeTasks[]>

          • Read task list for one node (finished tasks). GET /nodes/{node}/tasks

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { errors?: boolean; limit?: number; since?: number; source?: Tsource; start?: number; statusfilter?: string; typefilter?: string; until?: number; userfilter?: string; vmid?: number }
              • Optional errors?: boolean
              • Optional limit?: number
              • Optional since?: number
              • Optional source?: Tsource
              • Optional start?: number
              • Optional statusfilter?: string
              • Optional typefilter?: string
              • Optional until?: number
              • Optional userfilter?: string
              • Optional vmid?: number

            Returns Promise<nodesTasksNodeTasks[]>

      • termproxy: { $post: any }
      • time: { $get: any; $put: any }
        • $get:function
        • $put:function
          • $put(param: { timezone: string }): Promise<null>

          • Set time zone. PUT /nodes/{node}/time

            Allowtoken

            1

            Permissions

            Parameters

            • param: { timezone: string }
              • timezone: string

            Returns Promise<null>

      • version: { $get: any }
      • vncshell: { $post: any }
        • $post:function
          • $post(param?: { cmd?: Tcmd; cmd-opts?: string; height?: number; websocket?: boolean; width?: number }): Promise<nodesVncshellVncshell>

          • Creates a VNC Shell proxy. POST /nodes/{node}/vncshell

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { cmd?: Tcmd; cmd-opts?: string; height?: number; websocket?: boolean; width?: number }
              • Optional cmd?: Tcmd
              • Optional cmd-opts?: string
              • Optional height?: number
              • Optional websocket?: boolean
              • Optional width?: number

            Returns Promise<nodesVncshellVncshell>

      • vncwebsocket: { $get: any }
      • vzdump: { defaults: { $get: any }; extractconfig: { $get: any }; $post: any }
        • defaults: { $get: any }
          • $get:function
        • extractconfig: { $get: any }
          • $get:function
            • $get(param: { volume: string }): Promise<string>

            • Extract configuration from vzdump backup archive. GET /nodes/{node}/vzdump/extractconfig

              Allowtoken

              1

              Permissions

              Parameters

              • param: { volume: string }
                • volume: string

              Returns Promise<string>

        • $post:function
          • $post(param?: { all?: boolean; bwlimit?: number; compress?: Tcompress; dumpdir?: string; exclude?: string; exclude-path?: string; ionice?: number; lockwait?: number; mailnotification?: Tmailnotification; mailto?: string; maxfiles?: number; mode?: Tmode; pigz?: number; pool?: string; prune-backups?: string; quiet?: boolean; remove?: boolean; script?: string; stdexcludes?: boolean; stdout?: boolean; stop?: boolean; stopwait?: number; storage?: string; tmpdir?: string; vmid?: string; zstd?: number }): Promise<string>

          • Create backup. POST /nodes/{node}/vzdump

            Allowtoken

            1

            Permissions

            Parameters

            • Optional param: { all?: boolean; bwlimit?: number; compress?: Tcompress; dumpdir?: string; exclude?: string; exclude-path?: string; ionice?: number; lockwait?: number; mailnotification?: Tmailnotification; mailto?: string; maxfiles?: number; mode?: Tmode; pigz?: number; pool?: string; prune-backups?: string; quiet?: boolean; remove?: boolean; script?: string; stdexcludes?: boolean; stdout?: boolean; stop?: boolean; stopwait?: number; storage?: string; tmpdir?: string; vmid?: string; zstd?: number }
              • Optional all?: boolean
              • Optional bwlimit?: number
              • Optional compress?: Tcompress
              • Optional dumpdir?: string
              • Optional exclude?: string
              • Optional exclude-path?: string
              • Optional ionice?: number
              • Optional lockwait?: number
              • Optional mailnotification?: Tmailnotification
              • Optional mailto?: string
              • Optional maxfiles?: number
              • Optional mode?: Tmode
              • Optional pigz?: number
              • Optional pool?: string
              • Optional prune-backups?: string
              • Optional quiet?: boolean
              • Optional remove?: boolean
              • Optional script?: string
              • Optional stdexcludes?: boolean
              • Optional stdout?: boolean
              • Optional stop?: boolean
              • Optional stopwait?: number
              • Optional storage?: string
              • Optional tmpdir?: string
              • Optional vmid?: string
              • Optional zstd?: number

            Returns Promise<string>

      • wakeonlan: { $post: any }
        • $post:function
          • $post(): Promise<string>

          • Try to wake a node via 'wake on LAN' network packet. POST /nodes/{node}/wakeonlan

            Allowtoken

            1

            Permissions

            Returns Promise<string>

      • $get:function
  • $get:function

pools

pools: { $: any; $get: any; $post: any }

Type declaration

  • $:function
    • $(poolid: string): { $delete: any; $get: any; $put: any }

    • Parameters

      • poolid: string

      Returns { $delete: any; $get: any; $put: any }

      • $delete:function
        • $delete(): Promise<null>

        • Delete pool. DELETE /pools/{poolid}

          Allowtoken

          1

          Permissions

          Returns Promise<null>

      • $get:function
      • $put:function
        • $put(param?: { comment?: string; delete?: boolean; storage?: string; vms?: string }): Promise<null>

        • Update pool data. PUT /pools/{poolid}

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { comment?: string; delete?: boolean; storage?: string; vms?: string }
            • Optional comment?: string
            • Optional delete?: boolean
            • Optional storage?: string
            • Optional vms?: string

          Returns Promise<null>

  • $get:function
  • $post:function
    • $post(param: { comment?: string; poolid: string }): Promise<null>

    • Create new pool. POST /pools

      Allowtoken

      1

      Permissions

      Parameters

      • param: { comment?: string; poolid: string }
        • Optional comment?: string
        • poolid: string

      Returns Promise<null>

storage

storage: { $: any; $get: any; $post: any }

Type declaration

  • $:function
    • $(storage: string): { $delete: any; $get: any; $put: any }

    • Parameters

      • storage: string

      Returns { $delete: any; $get: any; $put: any }

      • $delete:function
        • $delete(): Promise<null>

        • Delete storage configuration. DELETE /storage/{storage}

          Allowtoken

          1

          Permissions

          Returns Promise<null>

      • $get:function
        • $get(): Promise<any>

        • Read storage configuration. GET /storage/{storage}

          Allowtoken

          1

          Permissions

          Returns Promise<any>

      • $put:function
        • $put(param?: { blocksize?: string; bwlimit?: string; comstar_hg?: string; comstar_tg?: string; content?: string; delete?: string; digest?: string; disable?: boolean; domain?: string; encryption-key?: string; fingerprint?: string; format?: string; fs-name?: string; fuse?: boolean; is_mountpoint?: string; keyring?: string; krbd?: boolean; lio_tpg?: string; master-pubkey?: string; maxfiles?: number; mkdir?: boolean; monhost?: string; mountpoint?: string; namespace?: string; nocow?: boolean; nodes?: string; nowritecache?: boolean; options?: string; password?: string; pool?: string; port?: number; preallocation?: Tpreallocation; prune-backups?: string; saferemove?: boolean; saferemove_throughput?: string; server?: string; server2?: string; shared?: boolean; smbversion?: Tsmbversion; sparse?: boolean; subdir?: string; tagged_only?: boolean; transport?: Ttransport; username?: string }): Promise<storageUpdate>

        • Update storage configuration. PUT /storage/{storage}

          Allowtoken

          1

          Permissions

          Parameters

          • Optional param: { blocksize?: string; bwlimit?: string; comstar_hg?: string; comstar_tg?: string; content?: string; delete?: string; digest?: string; disable?: boolean; domain?: string; encryption-key?: string; fingerprint?: string; format?: string; fs-name?: string; fuse?: boolean; is_mountpoint?: string; keyring?: string; krbd?: boolean; lio_tpg?: string; master-pubkey?: string; maxfiles?: number; mkdir?: boolean; monhost?: string; mountpoint?: string; namespace?: string; nocow?: boolean; nodes?: string; nowritecache?: boolean; options?: string; password?: string; pool?: string; port?: number; preallocation?: Tpreallocation; prune-backups?: string; saferemove?: boolean; saferemove_throughput?: string; server?: string; server2?: string; shared?: boolean; smbversion?: Tsmbversion; sparse?: boolean; subdir?: string; tagged_only?: boolean; transport?: Ttransport; username?: string }
            • Optional blocksize?: string
            • Optional bwlimit?: string
            • Optional comstar_hg?: string
            • Optional comstar_tg?: string
            • Optional content?: string
            • Optional delete?: string
            • Optional digest?: string
            • Optional disable?: boolean
            • Optional domain?: string
            • Optional encryption-key?: string
            • Optional fingerprint?: string
            • Optional format?: string
            • Optional fs-name?: string
            • Optional fuse?: boolean
            • Optional is_mountpoint?: string
            • Optional keyring?: string
            • Optional krbd?: boolean
            • Optional lio_tpg?: string
            • Optional master-pubkey?: string
            • Optional maxfiles?: number
            • Optional mkdir?: boolean
            • Optional monhost?: string
            • Optional mountpoint?: string
            • Optional namespace?: string
            • Optional nocow?: boolean
            • Optional nodes?: string
            • Optional nowritecache?: boolean
            • Optional options?: string
            • Optional password?: string
            • Optional pool?: string
            • Optional port?: number
            • Optional preallocation?: Tpreallocation
            • Optional prune-backups?: string
            • Optional saferemove?: boolean
            • Optional saferemove_throughput?: string
            • Optional server?: string
            • Optional server2?: string
            • Optional shared?: boolean
            • Optional smbversion?: Tsmbversion
            • Optional sparse?: boolean
            • Optional subdir?: string
            • Optional tagged_only?: boolean
            • Optional transport?: Ttransport
            • Optional username?: string

          Returns Promise<storageUpdate>

  • $get:function
  • $post:function
    • $post(param: { authsupported?: string; base?: string; blocksize?: string; bwlimit?: string; comstar_hg?: string; comstar_tg?: string; content?: string; datastore?: string; disable?: boolean; domain?: string; encryption-key?: string; export?: string; fingerprint?: string; format?: string; fs-name?: string; fuse?: boolean; is_mountpoint?: string; iscsiprovider?: string; keyring?: string; krbd?: boolean; lio_tpg?: string; master-pubkey?: string; maxfiles?: number; mkdir?: boolean; monhost?: string; mountpoint?: string; namespace?: string; nocow?: boolean; nodes?: string; nowritecache?: boolean; options?: string; password?: string; path?: string; pool?: string; port?: number; portal?: string; preallocation?: Tpreallocation; prune-backups?: string; saferemove?: boolean; saferemove_throughput?: string; server?: string; server2?: string; share?: string; shared?: boolean; smbversion?: Tsmbversion; sparse?: boolean; storage: string; subdir?: string; tagged_only?: boolean; target?: string; thinpool?: string; transport?: Ttransport; type: Ttype_18; username?: string; vgname?: string; volume?: string }): Promise<storageCreate>

    • Create a new storage. POST /storage

      Allowtoken

      1

      Permissions

      Parameters

      • param: { authsupported?: string; base?: string; blocksize?: string; bwlimit?: string; comstar_hg?: string; comstar_tg?: string; content?: string; datastore?: string; disable?: boolean; domain?: string; encryption-key?: string; export?: string; fingerprint?: string; format?: string; fs-name?: string; fuse?: boolean; is_mountpoint?: string; iscsiprovider?: string; keyring?: string; krbd?: boolean; lio_tpg?: string; master-pubkey?: string; maxfiles?: number; mkdir?: boolean; monhost?: string; mountpoint?: string; namespace?: string; nocow?: boolean; nodes?: string; nowritecache?: boolean; options?: string; password?: string; path?: string; pool?: string; port?: number; portal?: string; preallocation?: Tpreallocation; prune-backups?: string; saferemove?: boolean; saferemove_throughput?: string; server?: string; server2?: string; share?: string; shared?: boolean; smbversion?: Tsmbversion; sparse?: boolean; storage: string; subdir?: string; tagged_only?: boolean; target?: string; thinpool?: string; transport?: Ttransport; type: Ttype_18; username?: string; vgname?: string; volume?: string }
        • Optional authsupported?: string
        • Optional base?: string
        • Optional blocksize?: string
        • Optional bwlimit?: string
        • Optional comstar_hg?: string
        • Optional comstar_tg?: string
        • Optional content?: string
        • Optional datastore?: string
        • Optional disable?: boolean
        • Optional domain?: string
        • Optional encryption-key?: string
        • Optional export?: string
        • Optional fingerprint?: string
        • Optional format?: string
        • Optional fs-name?: string
        • Optional fuse?: boolean
        • Optional is_mountpoint?: string
        • Optional iscsiprovider?: string
        • Optional keyring?: string
        • Optional krbd?: boolean
        • Optional lio_tpg?: string
        • Optional master-pubkey?: string
        • Optional maxfiles?: number
        • Optional mkdir?: boolean
        • Optional monhost?: string
        • Optional mountpoint?: string
        • Optional namespace?: string
        • Optional nocow?: boolean
        • Optional nodes?: string
        • Optional nowritecache?: boolean
        • Optional options?: string
        • Optional password?: string
        • Optional path?: string
        • Optional pool?: string
        • Optional port?: number
        • Optional portal?: string
        • Optional preallocation?: Tpreallocation
        • Optional prune-backups?: string
        • Optional saferemove?: boolean
        • Optional saferemove_throughput?: string
        • Optional server?: string
        • Optional server2?: string
        • Optional share?: string
        • Optional shared?: boolean
        • Optional smbversion?: Tsmbversion
        • Optional sparse?: boolean
        • storage: string
        • Optional subdir?: string
        • Optional tagged_only?: boolean
        • Optional target?: string
        • Optional thinpool?: string
        • Optional transport?: Ttransport
        • type: Ttype_18
        • Optional username?: string
        • Optional vgname?: string
        • Optional volume?: string

      Returns Promise<storageCreate>

version

version: { $get: any }

Type declaration

  • $get:function

Settings

Member Visibility

Theme

Generated using TypeDoc