netbox-authorized-keys


Namenetbox-authorized-keys JSON
Version 1.0.8 PyPI version JSON
download
home_pageNone
SummaryNetBox plugin to store Authorized Keys
upload_time2024-12-10 13:15:05
maintainerNone
docs_urlNone
authorJan Krupa
requires_pythonNone
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # NetBox Authorized Keys Plugin

NetBox Authorized Keys is a plugin for NetBox that allows you to store and manage SSH authorized keys.

## Features

- Store SSH authorized keys
- Assign keys to devices or virtual machines
- Manage keys through the NetBox UI
- API support for managing keys

## Installation

1. Clone the repository:
    ```sh
    git clone https://github.com/yourusername/netbox_authorized_keys.git
    ```

2. Navigate to the project directory:
    ```sh
    cd netbox_authorized_keys
    ```

3. Install the plugin:
    ```sh
    pip install .
    ```

4. Add the plugin to your NetBox configuration:
    ```python
    PLUGINS = ["netbox_authorized_keys"]
    PLUGINS_CONFIG = {
        "netbox_authorized_keys": {
            # Add any plugin-specific configuration here
        }
    }
    ```

5. Run the migrations:
    ```sh
    python manage.py migrate
    ```

### Importing Keys through the GUI
- Visit `<NETBOX_URL>plugins/authorized-keys/authorized-keys/import/`
- Paste the authorized keys into the text area as YAML
- Example:
```yaml
- public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQq ... user@host"
  username: "admin"
  full_name: "System Administrator"
  description: "Admin SSH key"
  devices: R121,R119,DEVICE_NAME3
  virtual_machines: krupa.vm.cesnet.cz, VM_NAME2
  comments: "Primary admin access key"


- public_key: "ssh-ed25519 AAAAC3aaNzaC1lZDI1NTE5AAAAIJEj2f9jQS3zGOVKUtEtQXFvFJ6YyB4hjQvQEXEsEZGk developer@laptop"
  username: "developer"
  full_name: "Jane Developer"
  description: "Developer access key"
  comments: "Development environment access"
  tags: "tag_slug1,tag_slug2"
```
- Notes:
   - Tags slug need to be encased in quotes and separated by commas
   - Devices and virtual machines need to be specified by their name, enclosed in quotes, and separated by commas

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "netbox-authorized-keys",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Jan Krupa",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/31/76/fb51bb70909336aa6a9f996dfb079ccb6acc32b0250c1058c093e7578d67/netbox_authorized_keys-1.0.8.tar.gz",
    "platform": null,
    "description": "# NetBox Authorized Keys Plugin\n\nNetBox Authorized Keys is a plugin for NetBox that allows you to store and manage SSH authorized keys.\n\n## Features\n\n- Store SSH authorized keys\n- Assign keys to devices or virtual machines\n- Manage keys through the NetBox UI\n- API support for managing keys\n\n## Installation\n\n1. Clone the repository:\n    ```sh\n    git clone https://github.com/yourusername/netbox_authorized_keys.git\n    ```\n\n2. Navigate to the project directory:\n    ```sh\n    cd netbox_authorized_keys\n    ```\n\n3. Install the plugin:\n    ```sh\n    pip install .\n    ```\n\n4. Add the plugin to your NetBox configuration:\n    ```python\n    PLUGINS = [\"netbox_authorized_keys\"]\n    PLUGINS_CONFIG = {\n        \"netbox_authorized_keys\": {\n            # Add any plugin-specific configuration here\n        }\n    }\n    ```\n\n5. Run the migrations:\n    ```sh\n    python manage.py migrate\n    ```\n\n### Importing Keys through the GUI\n- Visit `<NETBOX_URL>plugins/authorized-keys/authorized-keys/import/`\n- Paste the authorized keys into the text area as YAML\n- Example:\n```yaml\n- public_key: \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQq ... user@host\"\n  username: \"admin\"\n  full_name: \"System Administrator\"\n  description: \"Admin SSH key\"\n  devices: R121,R119,DEVICE_NAME3\n  virtual_machines: krupa.vm.cesnet.cz, VM_NAME2\n  comments: \"Primary admin access key\"\n\n\n- public_key: \"ssh-ed25519 AAAAC3aaNzaC1lZDI1NTE5AAAAIJEj2f9jQS3zGOVKUtEtQXFvFJ6YyB4hjQvQEXEsEZGk developer@laptop\"\n  username: \"developer\"\n  full_name: \"Jane Developer\"\n  description: \"Developer access key\"\n  comments: \"Development environment access\"\n  tags: \"tag_slug1,tag_slug2\"\n```\n- Notes:\n   - Tags slug need to be encased in quotes and separated by commas\n   - Devices and virtual machines need to be specified by their name, enclosed in quotes, and separated by commas\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "NetBox plugin to store Authorized Keys",
    "version": "1.0.8",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3176fb51bb70909336aa6a9f996dfb079ccb6acc32b0250c1058c093e7578d67",
                "md5": "d236adb2aee31680c5ad3739f1fe72ab",
                "sha256": "e3508234133a4cf8c775b47e6b42f9e99b792def70a82657ebf5d34e015de77a"
            },
            "downloads": -1,
            "filename": "netbox_authorized_keys-1.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "d236adb2aee31680c5ad3739f1fe72ab",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13339,
            "upload_time": "2024-12-10T13:15:05",
            "upload_time_iso_8601": "2024-12-10T13:15:05.814205Z",
            "url": "https://files.pythonhosted.org/packages/31/76/fb51bb70909336aa6a9f996dfb079ccb6acc32b0250c1058c093e7578d67/netbox_authorized_keys-1.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-10 13:15:05",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "netbox-authorized-keys"
}
        
Elapsed time: 0.43461s