Memshell Methods¶
API for MemShell
- memshell.disable()¶
Disables MemShell access on the service. The current password must be specified.
Parameters: - name (String) – Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
- password (String) – The current Memshell password (as returned by memshell.enable().).
- memshell.enable()¶
Enables MemShell access on the service.
Parameters: - name (String) – Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
- password (String, Optional) – The password set set for authentication. A password will be generated and returned if this parameter is not supplied. Ensure this value has at least 10 characters.
Returns: a dictionary with following keys:
- password
String: The password used for authentication with Memshell, either the one you passed in or a randomly generated one if you didn’t.
- memshell.info()¶
Information about the MemShell service.
Parameters: name (String) – Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters. Returns: a dictionary with following keys: - enabled
- Boolean: True if MemShell access is enabled; otherwise False.
- hostname
- String: The hostname to connect to.
- port
- Integer: The TCP port to connect to
- username:
- String: The username to authenticate as.
- memshell.set_password()¶
Sets the Memshell password for the service. Memshell must already be enabled.
Parameters: - name (String) – Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
- current_password (String) – The current Memshell password (as returned by memshell.enable().).
- new_password (String) – The new password to set. Ensure this value has at least 10 characters.
