SambaManagerNet | Houston Common Library

Methods

addShare

addShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Add a new share configuration
Parameters
- share: SambaShareConfig
  share configuration to add
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.addShare
Overrides SambaManagerBase.addShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:332

`Private` addShareCommand

addShareCommand(name: string, path: string): Command
Parameters
- name: string
- path: string
Returns Command
- Defined in houston-common-lib/lib/managers/samba/manager.ts:243

checkIfSambaConfIncludesRegistry

checkIfSambaConfIncludesRegistry(sambaConfPath: string): neverthrow.ResultAsync<boolean, ParsingError | ProcessError>
Parameters
- sambaConfPath: string
Returns neverthrow.ResultAsync<boolean, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:378

`Private` delParmCommand

delParmCommand(section: string, param: string): Command
Parameters
- section: string
- param: string
Returns Command
- Defined in houston-common-lib/lib/managers/samba/manager.ts:251

`Private` delSectionParms

delSectionParms(section: string, params: string[]): neverthrow.ResultAsync<ExitedProcess[], ProcessError>
Parameters
- section: string
- params: string[]
Returns neverthrow.ResultAsync<ExitedProcess[], ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:271

`Private` delShareCommand

delShareCommand(section: string): Command
Parameters
- section: string
Returns Command
- Defined in houston-common-lib/lib/managers/samba/manager.ts:259

`Private` netConfCommand

netConfCommand(...args: string[]): Command
Parameters
- Rest ...args: string[]
Returns Command
- Defined in houston-common-lib/lib/managers/samba/manager.ts:235

parseConfig

parseConfig(config: string): neverthrow.Result<SambaConfig, ParsingError>
Parse complete samba configuration text (e.g. contents of smb.conf) into configuration object
Parameters
- config: string
  Complete configuration text
Returns neverthrow.Result<SambaConfig, ParsingError>
Implementation of ISambaManager.parseConfig
Inherited from SambaManagerBase.parseConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:155

parseGlobalConfig

parseGlobalConfig(globalConfig: string): neverthrow.Result<SambaGlobalConfig, ParsingError>
Parse global configuration text into global config object
Parameters
- globalConfig: string
  Global configuration text, including '[global]' header
Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
Implementation of ISambaManager.parseGlobalConfig
Inherited from SambaManagerBase.parseGlobalConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:149

parseShareConfig

parseShareConfig(shareConfig: string): neverthrow.Result<SambaShareConfig, ParsingError>
Parse configuration text into a share object
Parameters
- shareConfig: string
  Share configuration text, including '[share name]' header
Returns neverthrow.Result<SambaShareConfig, ParsingError>
Implementation of ISambaManager.parseShareConfig
Inherited from SambaManagerBase.parseShareConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:136

patchSambaConfIncludeRegistry

patchSambaConfIncludeRegistry(sambaConfPath: string): neverthrow.ResultAsync<SambaManagerNet, ProcessError>
Parameters
- sambaConfPath: string
Returns neverthrow.ResultAsync<SambaManagerNet, ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:386

recommendedGlobalDefaults

recommendedGlobalDefaults(): neverthrow.Result<SambaGlobalConfig, ParsingError>
Recommended defaults for global configuration. Maintained in ./recommended-defaults.conf

Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
Implementation of ISambaManager.recommendedGlobalDefaults
Inherited from SambaManagerBase.recommendedGlobalDefaults
- Defined in houston-common-lib/lib/managers/samba/manager.ts:163

recommendedShareDefaults

recommendedShareDefaults(): neverthrow.Result<SambaShareConfig, ParsingError>
Recommended defaults for a new share. Maintained in ./recommended-defaults.conf

Returns neverthrow.Result<SambaShareConfig, ParsingError>
Implementation of ISambaManager.recommendedShareDefaults
Inherited from SambaManagerBase.recommendedShareDefaults
- Defined in houston-common-lib/lib/managers/samba/manager.ts:169

removeShare

removeShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ProcessError>
Remove an existing share configuration
Parameters
- share: SambaShareConfig
  share to remove
Returns neverthrow.ResultAsync<SambaShareConfig, ProcessError>
Implementation of ISambaManager.removeShare
Overrides SambaManagerBase.removeShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:357

renameShare

renameShare(oldName: string, newName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Rename a share
Parameters
- oldName: string
- newName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Implementation of ISambaManager.renameShare
Inherited from SambaManagerBase.renameShare
- Defined in houston-common-lib/lib/managers/samba/manager.ts:213

`Private` setParmCommand

setParmCommand(section: string, param: string, value: string): Command
Parameters
- section: string
- param: string
- value: string
Returns Command
- Defined in houston-common-lib/lib/managers/samba/manager.ts:247

`Private` setSectionParams

setSectionParams(section: string, params: KeyValueData): neverthrow.ResultAsync<ExitedProcess[], ProcessError>
Parameters
- section: string
- params: KeyValueData
Returns neverthrow.ResultAsync<ExitedProcess[], ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:263

setUserPassword

setUserPassword(user: string, passwd: string): neverthrow.ResultAsync<void, ProcessError>
Add samba user with specific passwd
Parameters
- user: string
- passwd: string
Returns neverthrow.ResultAsync<void, ProcessError>
Implementation of ISambaManager.setUserPassword
Inherited from SambaManagerBase.setUserPassword
- Defined in houston-common-lib/lib/managers/samba/manager.ts:196

`Private` showShareCommand

showShareCommand(section: string): Command
Parameters
- section: string
Returns Command
- Defined in houston-common-lib/lib/managers/samba/manager.ts:255

unparseConfig

unparseConfig(config: SambaConfig): neverthrow.Result<string, ParsingError>
Unparse comlete samba configuration object back into smbd.conf format text
Parameters
- config: SambaConfig
Returns neverthrow.Result<string, ParsingError>
Implementation of ISambaManager.unparseConfig
Inherited from SambaManagerBase.unparseConfig
- Defined in houston-common-lib/lib/managers/samba/manager.ts:159

Class SambaManagerNet

Hierarchy-Diagram

Legend

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SambaManagerNet

Properties

Private commandOptions

Protected server

Methods

addShare

Parameters

Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>

Private addShareCommand

Parameters

Returns Command

checkIfSambaConfIncludesRegistry

Parameters

Returns neverthrow.ResultAsync<boolean, ParsingError | ProcessError>

Private delParmCommand

Parameters

Returns Command

Private delSectionParms

Parameters

Returns neverthrow.ResultAsync<ExitedProcess[], ProcessError>

Private delShareCommand

Parameters

Returns Command

editGlobal

Parameters

Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>

editShare

Parameters

Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>

exportConfig

Returns neverthrow.ResultAsync<string, ProcessError>

getGlobalConfig

Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>

getShare

Parameters

Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>

getShares

Returns neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>

importConfig

Parameters

Returns neverthrow.ResultAsync<SambaManagerNet, ProcessError>

importFromSambaConf

Parameters

Returns neverthrow.ResultAsync<SambaManagerNet, ProcessError>

listShareNames

Returns neverthrow.ResultAsync<string[], ProcessError>

Private listShareNamesCommand

Returns Command

Private netConfCommand

Parameters

Returns Command

parseConfig

Parameters

Returns neverthrow.Result<SambaConfig, ParsingError>

parseGlobalConfig

Parameters

Returns neverthrow.Result<SambaGlobalConfig, ParsingError>

parseShareConfig

Parameters

Returns neverthrow.Result<SambaShareConfig, ParsingError>

patchSambaConfIncludeRegistry

Parameters

Returns neverthrow.ResultAsync<SambaManagerNet, ProcessError>

recommendedGlobalDefaults

Returns neverthrow.Result<SambaGlobalConfig, ParsingError>

recommendedShareDefaults

Returns neverthrow.Result<SambaShareConfig, ParsingError>

removeShare

`Private` commandOptions

`Protected` server

`Private` addShareCommand

`Private` delParmCommand

`Private` delSectionParms

`Private` delShareCommand

`Private` listShareNamesCommand

`Private` netConfCommand

`Private` setParmCommand

`Private` setSectionParams

`Private` showShareCommand