Skip to content

ConnectionInfo

A snapshot of an SMB client connection.

Returned by Connection.info and connections.

Fields

kind @ ConnectionKind [get]

Resource kind. A provider resource type this binding does not model reports as :ANY:.

local @ (Str | nil) [get]

Redirected local device such as "Z:", or nil for a deviceless connection.

persistent @ Bool [get]

Whether the connection is recorded in the profile and restored at logon. Independent of state: a restored mapping whose server is reachable is both :CONNECTED: and persistent.

provider @ (Str | nil) [get]

Network provider name, or nil when the provider reports none.

remote @ Str [get]

Remote resource in UNC form.

state @ (:CONNECTED: | :REMEMBERED:) [get]

:CONNECTED: when the connection is established, :REMEMBERED: when it is saved in the profile but not currently connected -- what net use shows as Unavailable.

user @ (Str | nil) [get]

Account the connection authenticated as. A connection saved in the profile but not currently established has no account to report.