A toolbox of tasks to check and manage CTERA Edge Filers via GUI.
- Use a Portal Global Administrator account to login.
- There is currently no support for tenant admins or direct logins to Edge Filers. All requests are sent through the Portal to connected Edge Filers.
-
Ensure necessary Remote Administration settings are enabled on the portal: (Applies to portal versions older than 7.2)
Access the Global Administration view > Navigate to Settings > Control Panel > User Roles > Read/Write Administrator -> Ensure "Allow Single Sign On to Devices" is checked
General instructions. Actual commands will vary by distro and version.
git clone https://github.com/ctera/ctools.git
python -m pip install -r ctools/requirements.txt
For a machine without Python and git already installed, you can use these steps to simplify setup. Here we use Chocolatey as a commmand line package manager for Windows. Run PowerShell as an Administrator to setup. Close and re-open PowerShell after to refresh the environment and enable tab completion of commands.
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
choco install python --yes
choco install git --yes
# Close and re-open your shell
git clone https://github.com/ctera/ctools.git
python -m pip install --upgrade pip
python -m pip install -r .\ctools\requirements.txt
cd ctools
python ctools.py
Run a "hidden CLI command", i.e. execute a RESTful API request to each connected Edge Filer or to one specified Edge Filer.
Record current status of connected Edge Filers to a specified CSV output file.
Provide a portal URL, e.g. portal.ctera.me, to scan all connected Edge Filers to that tenant and write various bits of
information to a specified CSV file.
If an IP address is provided, the Default Tenant Portal will be used.
Or you can use/check the -a, --all flag to scan all connected Edge Filers across all Tenant Portals.
If the output filename already exists, the results will be appended to the existing file.
Suspend or Unususpend Cloud Drive syncing on a Edge Filer.
Enable or Disable the ssh service on a given Edge Filer and add the public key to the authorized_keys of the Edge Filer. If no public key is provided, a new keypair will generated and saved to the Downloads folder.
Enable the telnet service on a given Edge Filer. If no unlock code is provided, return the required MAC address and firmware version to get an unlock code from CTERA Support.
Reset a local user account password on a Edge Filer.
Create folder_groups and cloud folders using a pre-populated CSV file - download template here
- Replace content in file above with desired folder_group and cloud_folder names
Delete shares from all Gateway devices containing specified pattern
Copy Shares from one specified Edge Filer to a different specified Edge Filer
Add/remove domain users/groups to the Administrators group on all devices on all portals, all devices on specified portal tenant, or one device on specified portal tenant
PS C:\Users\ctera\git\ctools> python ctools.py
