ctxcli 0.1.1

CLI Tools for Amdocs ConnectX

Introduction

The ctxcli package provides Command Line Interface (CLI) tools for Amdocs ConnectX. These tools allow authorized ConnectX users to perform various operations on the system.

Installation

Before installing ctxcli, ensure that Python and pip are installed on your system.

To install ctxcli from PyPI, use the following command:

pip install ctxcli

Authentication

Before running any command, you need to authenticate by running the ‘auth’ command. Use the following command to authenticate:

ctxcli auth

You will be prompted to enter your tenant, environment (dev, ppe, prod), username, and password.

Commands

The ctxcli commands are divided into the following categories: Users, Tenant, and Migration.

Users

To list all the users in the system, use the following command:

ctxcli user list

This command will display a table with the following fields: Id, Username, Status, Enabled, Created (date), Last modified.

Tenant

To list all the sub-tenants in the system, use the following command:

ctxcli tenant list

This command will display a table with the following fields: Id, Name, Brand, Created (date).

Migration

To list all the migration files in the system, use the following command:

ctxcli migration file list

This command will display a table with the following fields: Id, Name, Created (date), Records (total number of records in the file), Pending (number of pending records), In Progress (number of in progress records), Done (number of done records), Failed (number of failed records), Status.

License

Copyright 2024 Amdocs