node-lxc
    Preparing search index...

    Type Alias lxc_attach_options

    lxc_attach_options: (
        | { env_policy: LXC_ATTACH_CLEAR_ENV; extra_keep_env: string[] }
        | { env_policy: LXC_ATTACH_KEEP_ENV }
    ) & {
        attach_flags: number;
        elevated_privileges: boolean;
        extra_env_vars: string[];
        gid?: number;
        groups?: number[];
        initial_cwd?: string;
        log_fd: number;
        lsm_label?: string;
        namespaces: number;
        personality: Personality | -1 | bigint;
        remount_sys_proc: boolean;
        stdio: [number, number, number];
        uid?: number;
    }

    Type Declaration

    • attach_flags: number

      Any combination of LXC_ATTACH_* flags

    • elevated_privileges: boolean

      ElevatedPrivileges runs the command with elevated privileges. The capabilities, cgroup and security module restrictions of the container are not applied. @WARNING: This may leak privileges into the container.

    • extra_env_vars: string[]

      Env specifies the environment of the process.

    • Optionalgid?: number

      GID specifies the group id to run as.

      Set to -1 for default behaviour (init gid for userns containers or 0 (super-user) if detection fails).

    • Optionalgroups?: number[]

      Groups specifies the list of additional group ids to run with. The additional group GIDs to run with. If unset all additional groups are dropped.

    • Optionalinitial_cwd?: string

      If the current directory does not exist in the container, the root directory will be used instead because of kernel defaults.

    • log_fd: number

      File descriptor to log output.

    • Optionallsm_label?: string

      lsm label to set.

    • namespaces: number

      Specify the namespaces to attach to, as OR'ed list of clone flags (syscall.CLONE_NEWNS | syscall.CLONE_NEWUTS ...).

    • personality: Personality | -1 | bigint

      Specify the architecture which the kernel should appear to be running as to the command executed. Initial personality (LXC_ATTACH_DETECT_PERSONALITY to autodetect).

      This may be ignored if lxc is compiled without personality support)

    • remount_sys_proc: boolean

      RemountSysProc remounts /sys and /proc for the executed command. This is required to reflect the container (PID) namespace context if the command does not attach to the container's mount namespace.

    • stdio: [number, number, number]

      [stdinfd, stdoutfd, stderrfd] stdinfd: specifies the fd to read input from. stdoutdf: specifies the fd to write output to. stderrfd: specifies the fd to write error output to.

    • Optionaluid?: number

      UID specifies the user id to run as.

      Set to -1 for default behaviour (init uid for userns containers or 0 (super-user) if detection fails).