.. meta:: :description: This documentation will guide you through the use of the Memset API. .. index:: double: Methods; memshell .. _memshell: Memshell Methods ---------------- API for MemShell .. function:: memshell.disable Disables MemShell access on the service. The current password must be specified. :param name: 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. :type name: String :param password: The current Memshell password (as returned by :func:`memshell.enable`.). :type password: String .. function:: memshell.enable Enables MemShell access on the service. :param name: 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. :type name: String :param password: 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. :type password: String, Optional :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. .. function:: memshell.info Information about the MemShell service. :param name: 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. :type name: String :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. .. function:: memshell.set_password Sets the Memshell password for the service. Memshell must already be enabled. :param name: 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. :type name: String :param current_password: The current Memshell password (as returned by :func:`memshell.enable`.). :type current_password: String :param new_password: The new password to set. Ensure this value has at least 10 characters. :type new_password: String