The NetBox Cloud team will set up your account with your email address as the username, and you will use this to access the cloud admin console. To complete the set up of your account for access to the Admin console, follow these steps:
+You will receive an email advising you of your username, along with a temporary password and a link to the console URL. Click the link to login
+Enter the username (your email address) and the temporary password as per the email, and click ‘Sign in’:
+
You will then be prompted to change your password:
+
The set up is now complete and you are logged into the NetBox Cloud Admin Console. You will see (and be able to administer) all the NetBox Cloud instances running under your Organization. In the example screenshot below there are two instances running (dev and prod):
+
To retrieve the credentials for the admin user of a NetBox Cloud instance, either click to reveal or copy them from the Secrets section:
+
Then click the on either of the two links to open the URL of the instance in a new browser window:
+
Lastly, login to the NetBox Cloud UI with the username and password you have copied from step 5:
+
To access your NetBox Cloud Administrative Console, follow these steps:
+Click on the arrow next your Organization Name and then click on the Namespace ID
+
Next scroll down and click on the NetBox panel, and then click on the NetBox ID link to launch the Administrative console
+
This compressed full page screenshot breaks the full Administrative Console down into similar sections. Each section is designed to give you greater insight to your NetBox instance.
+
The Information Panel provides a view of basic information relating to your NetBox Cloud instance. Here you will find the name of your NetBox Cloud instance within your Organization's Namespace, along with the AWS Region and the NetBox version. You also have a link to the instance raw URL, plus a refresh button for the instance data.
+
The NetBox Deployment panel lists various service and configuration status points. Included will be the current version, and version upgrade controls, the number of instance replicas, and resource allocations. The instance image and namespace are also listed here.
+The Secrets section provides access to the current secret credentials for the instance API Token, local “admin” user account and Secret Key. When the Administrative Console initially loads these values will be hidden.
+
The Ingress pannel gives the Name, Domain and DNS Name information for the NetBox Cloud instance, as well as the number of Ingress Pods and the Load Balancer status.
+
The Storage Panel contains information on the storage bucket, user, and access key ID. Clicking the open eye will reveal the Access Key secret details.
+
The Postgres Database panel (left) gives the current status of the database, along with details of the host, username and database name for the instance. Clicking the open eye will reveal the Postrges Database secret details.
+The Postgres panel (right) gives the number of database instances, their status, instance names, version, Aurora capacity unit consumption, current configured backup retention period, and security group IDs. Clicking the open eye will reveal the Postrges secret details.
+
The Redis Database panel (left) gives the name, status, host, user, and ID of the Main and Cache Redis databases.
+The Redis panel (right) gives the name, status, resource, image and version information for the Redis instance. Clicking the open eye will reveal the Redis secret details.
+
If the Ingress Allow List is configured, then inbound Web/API traffic will only be permitted to either IPv4 or IPv6 CIDR ranges listed on the Ingress Allow List.
+
This NetBox Configmap ENV allows you to view or manage the underlying variables for the instance
+
The NetBox Startup Configmaps (redacted screenshot) allows you to view or manage the underlying configmaps for the instance.
+
The Pods screen allows you to view the underlying composition of the instance. This includes versions, operational status, vCPU and Memory information.
+This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Microsoft Azure Active Directory (AD) as an authentication backend.
+Create a test user (optional) +Create a new user in AD to be used for testing. You can skip this step if you already have a suitable account created.
+Create an app registration +Under the Azure Active Directory dashboard, navigate to Add > App registration.
+
Enter a name for the registration (e.g. "NetBox Cloud") and ensure that the "single tenant" option is selected.
+Under "Redirect URI", select "Web" for the platform and enter the path to your NetBox Cloud installation, ending with /oauth/complete/azuread-oauth2/.
+Eg. https://{your-domain}.cloud.netboxapp.com/oauth/complete/azuread-oauth2/
+
Once finished, make note of the application (client) ID; this will be used when configuring NetBox Cloud.
+
Multitenant authentication
+NetBox also supports multitenant authentication via Azure AD, however it requires a different backend and an additional configuration parameter. Please see the python-social-auth documentation for details concerning multitenant authentication.
Create a secret
+When viewing the newly-created app registration, click the "Add a certificate or secret" link under "Client credentials". Under the "Client secrets" tab, click the "New client secret" button.
+
You can optionally specify a description and select a lifetime for the secret.
+
Once finished, make note of the secret value (not the secret ID); this will be used when configuring NetBox Cloud.
+
Securely share the following configuration parameters with NetBox Cloud Support, substituting your own values:
+REMOTE_AUTH_BACKEND = 'social_core.backends.azuread.AzureADOAuth2' +SOCIAL_AUTH_AZUREAD_OAUTH2_KEY = '{APPLICATION_ID}' +SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET = '{SECRET_VALUE}'
+The support team will add these parameters to your NetBox Cloud instance and confirm when this is ready for testing.
+Log out of NetBox Cloud if already authenticated, and click the "Log In" button at top right. You should see the normal login form as well as an option to authenticate using Azure AD. Click that link.
+
You should be redirected to Microsoft's authentication portal. Enter the username/email and password of your account to continue. You may also be prompted to grant this application access to your account.
+
If successful, you will be redirected back to the NetBox Cloud UI, and will be logged in as the AD user. You can verify this by navigating to your profile (using the button at top right).
+This user account has been replicated locally to NetBox Cloud, and can now be assigned groups and permissions within the NetBox Cloud admin UI.
+Azure requires that the authenticating client request a redirect URI that matches what you've configured for the app in step two. This URI must begin with https://
+If you are redirected to the NetBox Cloud UI after authenticating successfully, but are not logged in, double-check the configured backend and app registration. The instructions in this guide pertain only to the azuread.AzureADOAuth2 backend using a single-tenant app registration.
You can protect access to your NetBox Cloud instance by adding IPv4 and IPv6 addresses and ranges to an IP Allow List to control which source IP’s your instance will accept connections from.
+Note - Be careful as once you add CIDR ranges to the IP Allow List you will NOT be able to access the WebUI or API of your instance from any other IP addresses than those covered in the list. However, don’t worry if you make a mistake as you can easily remove incorrect entries from the list.
+Watch this quick video or follow the steps outlined below:
+ + +Login to the NetBox Labs Console and then click on the name of the NetBox instance you are updating, on the left-hand side.
+
Scroll down to the IP Allow List section and click Add on the right hand side:
+
Add your IP address or range in CIDR notation. Give the range a description, and click Publish to add it to the list:
+
Note if you are adding multiple entries, then you can click Publish after adding them all.
+To remove an entry from the IP Allow List, click the trash can icon next to the entry, which marks the entry for deletion:
+
Then click Publish to remove the entry. Again, you can update multiple entries before clicking on Publish.
+
If you encounter any issues while working with the IP Allow List raise a support ticket by emailing the NetBox Labs Support Team
+ + +This guide explains how to configure single sign-on (SSO) support for NetBox Cloud using Okta as an authentication backend.
+Note that Okta offers free developer accounts
+Create a test user (optional) +Create a new user in the Okta admin portal to be used for testing. You can skip this step if you already have a suitable account created.
+Create an app registration +Within the Okta administration dashboard, navigate to Applications > Applications, and click the "Create App Integration" button. Select "OIDC" as the sign-in method, and "Web application" for the application type.
+
On the next page, give the app integration a name (e.g. "NetBox Cloud") and specify the sign-in and sign-out URIs. These URIs should follow the formats below:
+
Under "Assignments," select the controlled access setting most appropriate for your organization. Click "Save" to complete the creation.
+Once finished, note the following parameters. These will be used to configured NetBox Cloud.
+
Securely share the following configuration parameters with NetBox Cloud Support, substituting your own values:
+REMOTE_AUTH_BACKEND = 'social_core.backends.okta_openidconnect.OktaOpenIdConnect' +SOCIAL_AUTH_OKTA_OPENIDCONNECT_KEY = '{Client ID}' +SOCIAL_AUTH_OKTA_OPENIDCONNECT_SECRET = '{Client secret}' +SOCIAL_AUTH_OKTA_OPENIDCONNECT_API_URL = 'https://{Okta domain}/oauth2/'
+The support team will add these parameters to your NetBox Cloud instance and confirm when this is ready for testing.
+Log out of NetBox Cloud if already authenticated, and click the "Log In" button at top right. You should see the normal login form as well as an option to authenticate using Okta. Click that link.
+
You should be redirected to Okta's authentication portal. Enter the username/email and password of your test account to continue. You may also be prompted to grant this application access to your account.
+
If successful, you will be redirected back to the NetBox Cloud UI, and will be logged in as the Okta user. You can verify this by navigating to your profile (using the button at top right).
+This user account has been replicated locally to NetBox Cloud, and can now be assigned groups and permissions within the NetBox Cloud admin UI.
+ + +To log into a NetBox Cloud instance with the admin username and password, you first need to login to the Admin Console and then retrieve the credentials. Follow these steps:
+Login to Admin Console and you will see (and be able to administer) all the NetBox Cloud instances running under your Organization. In the example screenshot below there are two instances running (dev and prod):
+
To retrieve the credentials for the admin user of a NetBox Cloud instance, either click to reveal or copy them from the Secrets section:
+
Then click the on either of the two links to open the URL of the instance in a new browser window:
+
Lastly, login to the NetBox Cloud UI with the username and password you have copied from step 2:
+
From within the NetBox Labs Admin Console you can easily enable and disable two-factor authentication (2FA) on a per-user basis.
+Watch this quick video or follow the steps outlined below:
+ + +Login to the NetBox Labs Console and then click on the down arrow (top-right) and select Setup Two-Factor.
+
Follow the on-screen instructions and scan the QR code with your Authenticator App of choice (eg. Google Authenticator):
+
Enter the code from your authenticator app and click confirm:
+
Click on the X in the top-right corner to close the dialog box:
+
Click on the down arrow (top-right) and select Sign Out:
+
Log back into the console with your username and password and then when prompted, enter the TOTP code generated by your authenticator app, and click Confirm
+
Login to the NetBox Labs Console and then click on the down arrow (top-right) and select Setup Two-Factor.
+
Enter the TOTP Code from your authenticator app and click Disable.
+
In the dialog box, note that Two-factor authentication is now disabled and close the dialog box.
+
If you encounter any issues while working with two-factor authentication, please raise a support ticket by emailing the NetBox Labs Support Team
+ + +To upgrade your version of NetBox Cloud, follow the steps outlined below or watch the video instructions:
+ + +In the admin console, click on the three dots in the top right corner of the instance you wish to upgrade and click Manage
+
In the Version Upgrade section, select the target version from the drop-down menu. In this example we are upgrading from v3.4.7 to v3.5.1
Then click Apply to start the upgrade process:
+
The upgrade will take a few minutes to complete. you can monitor the progress of the upgrade by navigating down to the Logs section, and clicking the refresh icon on the right hand side:
+
Then click on the name of the instance with the latest timestamp (you may see the state change from pending to running). This will display the output from the log of your upgraded instance as it starts up:
Refresh the logs again, and after a few minutes you should soon see only one running instance (or two if you have a HA deployment):
+
When the upgrade is complete, you will see the new version instance has a status of started and the new version number will be displayed in the Service Overview section:
If you encounter any issues while performing the upgrade, check the logs for error messages and raise a support ticket by emailing the NetBox Labs Support Team
+Within the NetBox Labs Console you can access the backups of your NetBox Cloud database, and are able to perform the following actions:
+Watch this quick video or follow the steps outlined below:
+ + +Login to the NetBox Labs Console and then click on the name of the NetBox instance you are working with, on the left-hand side:
+
Scroll down to the Backup and Restore panel and view the list of available backups.
+
From within the Backup and Restore panel click on Back Up Now, on the right-hand side:
+
Select the NetBox Cloud instance you wish to backup from the drop-down menu, then click Request Backup. Note that if you have multiple NetBox Cloud instances then they will appear in this list.
+
After a few seconds you will see the on-demand backup in the list of available backups:
+
Locate the backup file you wish to retrieve, and click Retrieve
+
The retrieval process will then start:
+
Once the file has been retrieved, click Download and the file will be downloaded to your local computer. Note the file is a gzip compressed archive of the SQL database file so it will end in .sql.gz
If you encounter any issues while working with database backups raise a support ticket by emailing the NetBox Labs Support Team
+ + +This document will help you get up and running with NetBox Cloud quickly. It highlights all the unique features provided by NetBox Cloud.
+NetBox Cloud is a managed deployment of the open source NetBox application, extended to improve user experience and maintained by NetBox Labs. NetBox Cloud provides all the power of NetBox without the burden of installation and long-term maintenance.
+All the NetBox Cloud features within the user interface (UI) are found under the "Cloud" heading of the navigation menu:
+
NetBox supports many configuration parameters that affect how it functions. There are two areas of the UI in which these parameters can be adjusted.
+The first area is under the administrative interface. To access this interface, you must be logged into NetBox as a user with administrator privileges. Navigate to the admin UI by expanding the user menu at top right and clicking the "Admin" link. Then, navigate to Extras > Config revisions > Add.
This form will allow you to set various configuration parameters. Once the desired configurations have been made, you may optionally provide a comment as to why the changes were made, and click the "Save" button. This will create a new revision of NetBox's configuration.
+Configuration changes made via the admin UI take effect immediately. If you would like to revert your changes at any point, you can do so within the admin UI by locating the desired previous revision and clicking the "Restore" button to its right.
+You may notice that some configuration parameters are not present from the configuration form in the admin UI. This is because these are not supported by NetBox as dynamic configuration parameters: They can be modified only by altering NetBox's configuration file. Such settings include: +- User authentication (including SSO) +- Enabling & configuring plugins +- Time & date formatting
+NetBox Cloud exposes these configuration parameters through its own interface, which can be reached by navigating to Cloud > Administration > Configuration.
Once the desired configuration parameters have been set, click the "Save & Restart" button. Note that the application of these changes does require a restart of some NetBox Cloud services, and access to the NetBox Cloud UI and API may be interrupted briefly.
+NetBox Cloud currently supports single sign-on (SSO) authentication for the following providers:
+We are implementing support for additional backends as customers request them. If you have a need for a specific authentication backend, please let us know.
+To enable SSO, select the desired backend and provide the required configuration parameters under the appropriate tab. For information on configuring your specific backend service, you can consult the SSO configuration guides in the NetBox documentation, or contact NetBox Labs for assistance.
+ + +Migrating from an on-premises NetBox open source instance to a NetBox Labs NetBox Cloud environment is a straightforward +process. Since NetBox Cloud is built using the same open source software you’re already using, most imports can be +completed quickly for a timely cutover. This checklist will walk you through the steps, highlighting mandatory and optional +points in the process.
+Navigate to your NetBox portal login page to view the version of NetBox you are running. You can also find this information +within the application. This helps the NetBox team understand which upgrade path is required for your data.
+Use the following command to export your existing NetBox database:
+pg_dump --no-owner --no-privileges --username [netbox] --password --host [localhost] [netbox] > [netbox.sql]
+++Warning +Inform the NetBox Labs team if you used any additional flags for the pg_dump command, or if you exported the data to a +different format.
+
Optionally, if you are storing images inside NetBox, use the command below to archive your media directory. Note that the +example below shows the default file path. Update the path if you have changed the location of these files.
+tar -czf netbox_media.tar.gz /opt/netbox/netbox/media/
+Optionally, if you have uploaded custom scripts to NetBox, use the command below to archive your scripts directory. Note that +the example below shows the default file path. Update the path if you have changed the location of these files.
+tar -czf netbox_scripts.tar.gz /opt/netbox/netbox/scripts/
+Optionally, if you have uploaded custom reports to NetBox, use the command below to archive your reports directory. Note +that the example below shows the default file path. Update the path if you have changed the location of these files.
+tar -czf netbox_scripts.tar.gz /opt/netbox/netbox/reports/
+Upload the files created in the steps above to a shareable location such as FTP, Dropbox, Box, or Google Drive. If necessary, the +NetBox Labs team can create a secure, dedicated location for you to use.
+ + +\n {translation(\"search.result.term.missing\")}: {...missing}\n
\n }\n \n