aac-init


Nameaac-init JSON
Version 0.3.97 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2024-10-18 06:47:45
maintainerNone
docs_urlNone
authorRudy Lei
requires_python<4.0,>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Tests](https://github.com/nac-aci/aac-init/actions/workflows/test.yml/badge.svg)](https://github.com/nac-aci/aac-init/actions/workflows/test.yml)
![Python Support](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-informational "Python Support: 3.10, 3.11, 3.12")

# aac-init

A CLI tool to bootstrap and configure ACI fabric using ACI as Code.

```bash
$ aac-init -h
Usage: aac-init [OPTIONS]

  A CLI tool to bootstrap and configure ACI fabric using ACI as Code.

Options:
  --version                       Show the version and exit.
  -d, --data PATH                 Path to aac-init YAML data files.
                                  [required]
  -l, --log-level [debug|info|warning|error|critical]
                                  Specify the logging level. Default setting
                                  is 'info'.  [default: info]
  -h, --help                      Show this message and exit.
```

All data from the YAML files (`-d/--data` option) will use to bootstrap and configure ACI fabric.

The data folder **MUST** use following structure, `00-global_policy.yml` and `01-fabric_mgmt.yml` are **mandatory required**, see `docs/data_template` for details.

```bash
data/
├── 00-global_policy.yml      # mandatory, ACI fabric global policies
└── nac_data
    ├── 01-fabric_mgmt.yml    # mandatory, ACI fabric switch connection information
    └── other-yaml-files..    # optional, other ACI as Code configurations
```

## Prerequisite

- Working knowledge of ACI and [Network as Code - ACI](https://netascode.cisco.com/)
- A HTTP/TFTP server is required to store APIC/ACI switch image for wiping/booting APIC/ACI switch to particular version. See `docs/image_server` if you don't have experience on setting up image server.

## Installation

Python 3.10+ is required to install `aac-init`. Don't have Python 3.10 or later? See [Python 3 Getting Started](https://www.python.org/about/gettingstarted/).

`aac-init` can be installed using `pip`:

```bash
pip install aac-init
```

You will also need to install ansible and related NetworkAsCode dependencies, see Cisco [Network As Code - Ansible](https://netascode.cisco.com/solutions/aci/ansible/quick_start/#local-installation) for details. You can also find `requirements.yml/requirements.txt` at `docs/requirements`.

```bash
apt-get install ansible
ansible-galaxy install -r requirements.yml
pip install -r requirements.txt
```

## Usage

```bash
$ aac-init -d data/
Select single or multiple choice(s) to init ACI Fabric:
[1]  Wipe and boot APIC/switch to particular version
[2]  APIC initial setup (Single Pod)
[3]  Init ACI Fabric via NaC (Network as Code)
Example: (1,2,.. or *): *

Are you sure to proceed with the following choice(s)?
[1] Wipe and boot APIC/switch to particular version
[2] APIC initial setup (Single Pod)
[3] Init ACI Fabric via NaC (Network as Code)
 (yes, no) [yes]:
```

## Update aac-init to latest version

```bash
pip install aac-init --upgrade
```

## Uninstallation

```bash
pip uninstall aac-init
```

## FAQ

## Contact

[Rudy Lei](shlei@cisco.com)

## Contributors

[Rudy Lei](shlei@cisco.com)  
[Xiao Wang](xiawang3@cisco.com)  
[Song Wang](songwa@cisco.com)  
[Yang Bian](yabian@cisco.com)  
[Linus Xu](linxu3@cisco.com)  

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "aac-init",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Rudy Lei",
    "author_email": "shlei@cisco.com",
    "download_url": "https://files.pythonhosted.org/packages/bc/ff/0cf3127e55c1d76477adc8467c908af1ea1398cb47dd597b1279bccf2b02/aac_init-0.3.97.tar.gz",
    "platform": null,
    "description": "[![Tests](https://github.com/nac-aci/aac-init/actions/workflows/test.yml/badge.svg)](https://github.com/nac-aci/aac-init/actions/workflows/test.yml)\n![Python Support](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-informational \"Python Support: 3.10, 3.11, 3.12\")\n\n# aac-init\n\nA CLI tool to bootstrap and configure ACI fabric using ACI as Code.\n\n```bash\n$ aac-init -h\nUsage: aac-init [OPTIONS]\n\n  A CLI tool to bootstrap and configure ACI fabric using ACI as Code.\n\nOptions:\n  --version                       Show the version and exit.\n  -d, --data PATH                 Path to aac-init YAML data files.\n                                  [required]\n  -l, --log-level [debug|info|warning|error|critical]\n                                  Specify the logging level. Default setting\n                                  is 'info'.  [default: info]\n  -h, --help                      Show this message and exit.\n```\n\nAll data from the YAML files (`-d/--data` option) will use to bootstrap and configure ACI fabric.\n\nThe data folder **MUST** use following structure, `00-global_policy.yml` and `01-fabric_mgmt.yml` are **mandatory required**, see `docs/data_template` for details.\n\n```bash\ndata/\n\u251c\u2500\u2500 00-global_policy.yml      # mandatory, ACI fabric global policies\n\u2514\u2500\u2500 nac_data\n    \u251c\u2500\u2500 01-fabric_mgmt.yml    # mandatory, ACI fabric switch connection information\n    \u2514\u2500\u2500 other-yaml-files..    # optional, other ACI as Code configurations\n```\n\n## Prerequisite\n\n- Working knowledge of ACI and [Network as Code - ACI](https://netascode.cisco.com/)\n- A HTTP/TFTP server is required to store APIC/ACI switch image for wiping/booting APIC/ACI switch to particular version. See `docs/image_server` if you don't have experience on setting up image server.\n\n## Installation\n\nPython 3.10+ is required to install `aac-init`. Don't have Python 3.10 or later? See [Python 3 Getting Started](https://www.python.org/about/gettingstarted/).\n\n`aac-init` can be installed using `pip`:\n\n```bash\npip install aac-init\n```\n\nYou will also need to install ansible and related NetworkAsCode dependencies, see Cisco [Network As Code - Ansible](https://netascode.cisco.com/solutions/aci/ansible/quick_start/#local-installation) for details. You can also find `requirements.yml/requirements.txt` at `docs/requirements`.\n\n```bash\napt-get install ansible\nansible-galaxy install -r requirements.yml\npip install -r requirements.txt\n```\n\n## Usage\n\n```bash\n$ aac-init -d data/\nSelect single or multiple choice(s) to init ACI Fabric:\n[1]  Wipe and boot APIC/switch to particular version\n[2]  APIC initial setup (Single Pod)\n[3]  Init ACI Fabric via NaC (Network as Code)\nExample: (1,2,.. or *): *\n\nAre you sure to proceed with the following choice(s)?\n[1] Wipe and boot APIC/switch to particular version\n[2] APIC initial setup (Single Pod)\n[3] Init ACI Fabric via NaC (Network as Code)\n (yes, no) [yes]:\n```\n\n## Update aac-init to latest version\n\n```bash\npip install aac-init --upgrade\n```\n\n## Uninstallation\n\n```bash\npip uninstall aac-init\n```\n\n## FAQ\n\n## Contact\n\n[Rudy Lei](shlei@cisco.com)\n\n## Contributors\n\n[Rudy Lei](shlei@cisco.com)  \n[Xiao Wang](xiawang3@cisco.com)  \n[Song Wang](songwa@cisco.com)  \n[Yang Bian](yabian@cisco.com)  \n[Linus Xu](linxu3@cisco.com)  \n",
    "bugtrack_url": null,
    "license": null,
    "summary": null,
    "version": "0.3.97",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06ae9016aeedf174227d6c300a116da26f92f7c3c80f2287e6a6d03505d2e039",
                "md5": "3a35862079b8bd53d6a5b62045ecf7ab",
                "sha256": "2ebee57d0f4581872234cccce36818d059c46c577fc0f2d3e961e2910a641fef"
            },
            "downloads": -1,
            "filename": "aac_init-0.3.97-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3a35862079b8bd53d6a5b62045ecf7ab",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 44770,
            "upload_time": "2024-10-18T06:47:43",
            "upload_time_iso_8601": "2024-10-18T06:47:43.971778Z",
            "url": "https://files.pythonhosted.org/packages/06/ae/9016aeedf174227d6c300a116da26f92f7c3c80f2287e6a6d03505d2e039/aac_init-0.3.97-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bcff0cf3127e55c1d76477adc8467c908af1ea1398cb47dd597b1279bccf2b02",
                "md5": "f13d4480ca7315803e6ff23abe3a44ae",
                "sha256": "ce50eebd4686c69b2f66116517f03bad33c0777e1e37680e1d69a28664c3af71"
            },
            "downloads": -1,
            "filename": "aac_init-0.3.97.tar.gz",
            "has_sig": false,
            "md5_digest": "f13d4480ca7315803e6ff23abe3a44ae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 35949,
            "upload_time": "2024-10-18T06:47:45",
            "upload_time_iso_8601": "2024-10-18T06:47:45.093837Z",
            "url": "https://files.pythonhosted.org/packages/bc/ff/0cf3127e55c1d76477adc8467c908af1ea1398cb47dd597b1279bccf2b02/aac_init-0.3.97.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-18 06:47:45",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "aac-init"
}
        
Elapsed time: 0.78011s