Interface GlobalOptions

Global options for all commands.

Hierarchy

  • GlobalOptions

Indexable

[index: string]: boolean | string | undefined

Properties

-0? -4? -6? -B? -M? dryRun? filePath? stdin? sudo?

Properties

Optional -0

-0?: true

Shortcut for -family link.

Remarks

Specifies the protocol family to use.

Optional -4

-4?: true

Shortcut for -family inet.

Remarks

Specifies the protocol family to use.

Optional -6

-6?: true

Shortcut for -family inet6.

Remarks

Specifies the protocol family to use.

Optional -B

-B?: true

Shortcut for -family bridge.

Remarks

Specifies the protocol family to use.

Optional -M

-M?: true

Shortcut for -family mpls.

Remarks

Specifies the protocol family to use.

Optional dryRun

dryRun?: boolean

If set, the command won't be executed, just the command line will be built. Useful for debugging since the command will return a Command class, which provides access to Command.cmdToExec for debugging.

Optional filePath

filePath?: string

Required for certain commands that need a file path to create a file or consume it.

Optional stdin

stdin?: string

Required for certain commands that need stdin input.

Optional sudo

sudo?: boolean

When provided, will prepend the command with sudo, which effectively instructs the OS to execute the command with elevated privileges.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc