diff --git a/docs/administration/appliance-manager/index.md b/docs/administration/appliance-manager/index.md new file mode 100644 index 00000000..6d570f17 --- /dev/null +++ b/docs/administration/appliance-manager/index.md @@ -0,0 +1,6 @@ +--- +title: "Appliance Manager" +--- + +The Device42 Appliance Manager runs on port 4242 (HTTP by default; enable HTTPs within) to manage various Device42 Administrative functions. You can do backups & restores, manage HTTPS certifcates, Restart/Stop the application, generate logs or SNMPwalks for tech support, and more. The following topics are covered in this section: + diff --git a/docs/administration/passwords/index.md b/docs/administration/passwords/index.md new file mode 100644 index 00000000..d6891a35 --- /dev/null +++ b/docs/administration/passwords/index.md @@ -0,0 +1,6 @@ +--- +title: "Passwords" +--- + +Device42 software lets IT teams manage shared passwords in a secure fashion.  In this section, we will discuss the security and various password operations covered via the following topics: +  diff --git a/docs/administration/role-based-access-control/index.md b/docs/administration/role-based-access-control/index.md new file mode 100644 index 00000000..ada106c8 --- /dev/null +++ b/docs/administration/role-based-access-control/index.md @@ -0,0 +1,186 @@ +--- +title: "Role-Based Access Control" +--- + +### Role-Based Access Control Overview + +Device42 supports a number of role-based access use cases. A corporation might want to restrict access by geographic location, department, division, corporate entity, and so on. More importantly, they might want a user to have access to just one department while another user has access to all departments within a division. + +Similarly, a service provider might to allocate subnets to customers or racks to customers. The role-based access feature enables the service provider to restrict customer access to the specific subnets and racks assigned to the customer where the service provider can see all subnets and racks. + +### Setting Up Role-Based Access + +To set up role-based access in Device42, navigate to _Tools > Settings > Global Settings_, and click _Edit_ at the top right of the page. + +![](/assets/images/WEB-642_Role-Access-Multitenancy.png) + +The two Role-Based Access Control options are: + +- **Role-Based Access Control Option – Off:** _This is the default._ Do not change this option unless you want to enable role-based access. +- **Role-Based Access Control Option –  On:** Choose this option to enable role-based access. + +The other three _orphaned objects_ options are explained below. + +Click _Save_ at the bottom of the Global Settings page to save your selections. + +### Functional vs. Object Permissions + +If role-based access is not enabled, admin groups are granted only "Functional Permissions". These functional permissions define which menu items can be seen by users assigned to the group. + +![Multitenancy](/assets/images/2015-10-19-mt-2.png) + +When role-based access is initially turned on, superusers will still have access to all objects (i.e. buildings, rooms, racks, ...) in the system. However, non-superusers will not see any objects whatsoever until they are granted permission to see those objects so long as none of the 'allow orphaned objects' checkboxes shown in the top screenshot are selected. See the section below on 'orphaned objects' for a more complete explanation. + +![Multitenancy](/assets/images/2016-12-30-multitenancy2.png) + +When role-based access is enabled, users will only be able to see a device, asset, or pdu if an Object Category is assigned to that device, asset, or pdu and the user is granted access to that Object Category as shown above. + +![Multitenancy](/assets/images/2016-12-30-multitenancy3.png) + +Object Categories can be found on the Datacenter menu. As shown above, to create an object category, you enter a Name and an optional description. + +Admin groups, in turn, can be assigned to each object category and the category is granted view-only or change permission. In the above example, two admin groups, Prod and 760 Chapel St have been granted change permission to the Prod -- Change object category. This means that any user who has been assigned to either of the two groups has permission to modify any device, asset, or PDU that has been assigned the Prod -- Change object category. + +In the initial release of the role-based access feature, the admin groups were assigned directly to devices, assets, and PDUs. However, customers told us that, because of the vast number of devices, assets, and PDUs, this was just too much work. This is why we introduced Object Categories. + +For other objects that aren't as numerous as devices and assets (e.g. buildings, rooms, racks, customers, purchases, and object categories themselves), object permissions are still created by assigning admin groups directly to these types of objects as shown in the object categories assignment above. + +Many customers won't need to use Object Categories at all for devices, assets, and PDUs. Instead, you can simply assign admin groups to buildings, rooms, and racks. If an admin group has permission to a building, they have permission to every object in that building (i.e. every room, rack, device, PDU, asset). If an admin group has permission to a room, they have permission to every object in that room (i.e. every rack, device, PDU, asset). + +### Do Not Propagate Option + +![Multitenancy](/assets/images/2016-12-30-multitenancy4.png) + +The _"Do Not Propagate"_ option (pictured above) can be set on Buildings, Rooms, and Racks to stop automatic permission propagation. If you'd prefer that inheritance rules are not applied to a specific building, room, or rack, you can check the _'Do not propagate...'_ link shown above for a rack. In the above example, devices, assets, and pdu in rack NHCTDC1R2 will be visible to anyone who can see the rack. This is useful, for example, for a colocation operator who wants to split a rack among different customers. In the rack layout view, a customer with permission to see the rack and some devices in the rack but not others will see a grayed out rack with no information for those devices, assets, and PDUs they are not allowed to see. + +### Subnet Categories + +Subnet Categories work on subnets exactly like Object Categories work on devices, assets, and PDUs. You create Subnet Categories from the IPAM menus and assign admin groups to subnet categories just like you do for object categories. Then the subnet categories and their admin group assignments determine which subnets (and which IPs in those subnet) are visible and changeable for a given user. + +As with object categories, it's not necessary to assign a subnet category to every subnet. If a group is assigned to a VRF Group, then every subnet in that VRF Group will inherit the permissions of the VRF Group. Also, if a subnet is assigned a subnet category, then every child subnet of that subnet will also acquire the permissions granted by the subnet category. + +### Assigning Object Permissions to Admin Groups + +Object permissions are applicable to the following objects: - Buildings - Rooms - Racks - Devices - Assets - Object Categories - PDUs - VRF Groups - Subnet Categories - Purchases - Vendors - Customers - Auto Discovery jobs + +Object assignments are made either from the list view of the object or the edit page of a specific object. It is also possible to assign object permissions to discovered objects of auto discovery jobs. + +![Multitenancy](/assets/images/2015-10-19-mt-5.png) + +In the example above, we are about to assign 4 racks to an object permission group. If you click the "Add/Delete Object Permission Group" action and then click "Go", you will see... + +![Multitenancy](/assets/images/2015-10-19-mt-6.png) + +Here we are about to assign permission to the 4 racks listed above the the IT Managers admin group. If you click "Add, you will give the IT Managers group the right to view and edit these 4 racks. If you do not check the Change Permission box, then the permission will be view only. + +This dialog is also used to remove previously assign permissions. So, if you wanted to delete the IT Manager's permissions for these 4 racks, you would click the "Delete" button. You can also modify the Change Permission flag through this dialog as well. + +You can also assign permissions from object edit pages as shown above. + +The Add/Delete Groups action is available for the following objects: - Buildings - Rooms - Racks - VRF Groups + +Similarly, the Device, Asset, and PDU list pages offer Set Object Category and a Delete Object Category actions. The Subnet list page offers Set Subnet Category and a Delete Subnet Category actions. + +### Permission Hierarchies + +As mentioned above, if an admin group is granted access to a building, the admin group is implicitly granted access to all rooms, racks, devices, pdus, and assets in the building. We call the hierarchy that contains buildings the Device Hierarchy. The rules for the Device Hierarchy are as follows: + +- Permission for a building implies permission for all rooms, racks, devices, pdus, and assets in the building. +- Permission for a room implies permission for all racks, devices, pdus, and assets in the room. +- Permission for a rack implies permission for all devices, pdus, and assets in the rack (unless the "Do not propagate" box is checked for the rack). +- Permission for a blade chassis implies permission for all blade devices in the chassis. +- Permission for a virtual host implies permission for all virtual machines in the host. +- Permission for a device that is part of a cluster _does not_ imply permission to the cluster device itself. Additionally, as a cluster can be made up of devices that reside in multiple physical locations, a cluster device can not and does not have a location attribute, meaning permissions for those using multi-tenancy will be inherited for cluster member devices, but will not be inherited for the cluster device itself. The only way to create permissions on a cluster object is to assign an object category to the cluster device. + +Also as mentioned above, there is a second hierarchy that we call the IP Hierarchy. The rules for the IP Hierarchy are as follows: + +- Permission for a vrf group implies permission for all subnets and IP addresses within the vrf group. +- Permission for a subnet category implies permission for all subnets labeled with that subnet category, all child subnets of those subnets and all IP addresses within all those subnets. +- Permission for a parent subnet implies permission for all child subnets (e.g. permission for a /20 subnet implies permission for a /24 subnet). + +Please note that change permission for an object also applies to the objects beneath it in the hierarchy. For example, if you have change permission for a subnet, you can change any IPs in the subnet and you can add IPs (or child subnets) to the subnet. However, if you have view-only access to the subnet (i.e. you do not have change permission), then you can not change any IPs in the subnet and you cannot add IPs to the subnet. + +It is possible to grant view-only permission to a room but change permission to specific devices. This would allow users to change the specific devices but not change the other devices in the room. + +_Lastly, note that there is a special scenario such that an admin group with "change" permission assigned to a building, room, or rack in conjunction with the "Do Not Propagate" (aka DNP) option being selected. In this case, members of the Admin Group in question will end up with a "View Only" user experience, as the "change" permission's propagation in this scenario is blocked by the DNP option._ + +### Objects that Do Not Have Explicit Permissioning + +Certain objects are subject to permissioning even though admin groups are not directly granted these permissions. + +- Parts are viewable and/or editable if they are assigned to a device, room, or storage rack that is viewable or editable. +- UCS Service Profiles are viewable and/or editable if they are assigned to a device that is viewable or editable. +- Software components are viewable by all. However, software details are viewable or editable if the software component is in use by a device or end user is viewable or editable. +- Services are viewable by all. However, service details are viewable or editable if the service is in use by a device or end user is viewable or editable. +- Application components are viewable or editable only if they are attached to a service that is viewable or editable. +- Mac addresses are viewable or editable if they are attached to a device that is viewable or editable. + +### What Happens If an Admin Group Has No Permissions? + +The Device42 role-based access system is set up so that if an admin group is assigned no object permissions and no object or subnet categories, then users in that admin group will not be able to see any objects (unless 'orphaned objects' are allowed -- see below). As discussed above, if an admin group has access to only one room (and 'do not propagate' is unchecked) then users in the admin group will have access to that room and any racks, devices, pdus, and assets inside the room. However, if the admin group has not been granted access to any subnets, then the users will not be see any subnets or ips in their list pages. + +Note: Under certain circumstances, it is possible to see the name of an object without permission. For example, a user with access to a device will see the IP address of the device even if they don't have permission to see the subnet the IP address resides in. However, when they click on the IP address, they will get a permission error. + +The following objects and/or screens do not have object-level permission and are governed only by admin group functional permissions: - Hardware models, pdu models, patch panel models, tap module models, parts models, and similar objects - QR, Device Names, and Asset Number Profiles - Telecom and Power circuits - DNS - OS’s - Passwords (also have their own user/group security) - Lifecycle Event Actions - Misc Functions - Custom Field setup - Monitoring appliances - Org units - Settings - Tags + +### Viewing Role-Based Access Permissions + +For your convenience, in the view page for every object with permissions, there is a view-only field named “Group Permissions” (see the example above for Physical Device NTCTCORE01). This field tells you what groups are assigned to this device taking into account any groups assigned via device categories (see below) and taking into accounts groups assigned via buildings, rooms, or racks that contain the device and take into account VMs and blade chassis that contain the device + +Also, the group view and edit screens for admin groups will have 3 extra buttons (circled in red below): + +![Multitenancy](/assets/images/2015-10-19-mt-3.png) + +The Direct Permissions button will show a list of all objects that have been directly assigned to the group. If the group has been assigned to a specific device, the device will appear in the report. If the group has been assigned a building, devices in the building that do not have a direct group assignment will not be shown even though these devices "inherit" permissions from the building. An example is shown below... + +![Multitenancy](/assets/images/2015-10-19-mt-4.png) + +If you click the "All Permissions" button, you will see both direct and inherited permissions for objects for this group. If you click the "Inherited Permissions" button, you will see just the inherited permissions. + +Last, but often the most useful, list pages for permissioned objects have two types of filters. First, you can filter by an admin group to see all the objects that group can view. Second, you can filter by an Object or Subnet Category to see all objects that can be seen by groups with view permissions for the category. + +### Autodiscovery Jobs + +When you create or modify an autodiscovery job, you can assign an admin group to the autodiscovery job. This governs which users can can view and/or modify the autodiscovery job. You can also add groups in bulk to multiple jobs from the list view. + +Within many of the autodiscovery jobs, you can also assign an object category and/or a subnet category. The object category will then be assigned to any devices, assets, or pdus discovered. The subnet category will be assigned to any discovered subnets. + +Warning: If you are a non-superuser and you run an autodiscovery without specifying any categories, then you may not be able to view or edit the discovered objects (because you will not have permission to see them!). + +### Who Can Assign Admin Groups to Objects? + +Superusers are allowed to add, change, delete groups for objects through the UI, import spreadsheets, or the API. Superusers can also enable non-superusers to have this ability by assigning them them add, change, and/or delete capability for "Object Permissions". + +![Multitenancy](/assets/images/2016-3-15-mt-10.png) + +When you turn on role-based access, you will need to go to each admin group and make sure that each has or does not have the object permissions you want it to have. If you give a group add/change/delete permission, then all users assigned to that group (including non-superusers) will have the ability to add/change/delete object permissions through the UI, imports, and APIs. + +### IPAM Hierarchy Rules + +The Merge and Relocate subnet capabilities are available to any user with change permission to both the to-be-moved subnet and the parent subnet. + +Only superusers can create subnets from the subnet list page. However, non-superusers can create subnet from the subnet tree view. + +Only superusers can create parent root subnets. The only exception to this rule is the Ping Sweep Autodiscovery job. If a ping sweep job setup by a non-superuser discovers a root subnet, it will be created. + +If you do have view but not change permission to a device, you can still add an IP address to the device. This is considered by Device42 to be a modification of the IP address not the device. + +### Device Hierarchy Rules + +If you give a group change permission to a room, you should also grant view permission to the building for the room. Otherwise, the user won't be able to select a building and, without a building specified, they won't be able to save the room edit form. + +When cloning devices and racks with explicit permissions, those permissions will be copied over to the newly cloned objects. If there are no permissions on a device or rack, it will copy over the next closest parent's object permissions (e.g. if there are no permissions on a device but there are permissions on the rack the device is in, the rack's permissions will be copied over). Also, if a device or rack has multiple groups, only the groups assigned to the current user will be copied over. + +When deleting permissions on an object which has objects below it in the hierarchy (e.g. deleting a building which has rooms, racks, devices, ...), removing the permissions on the building will not cascade the delete down the line. So any rooms within the building that you deleted permissions from will still be available to the group. + +### Orphaned Objects + +An “orphaned object” is an object (e.g. a rack or a subnet) that has no group assigned to it directly AND has no group assigned to a “parent object”. To refresh your memory, the parent objects of racks are rooms and buildings and the parent objects of subnets are their parent subnets and vrf groups. Prior to this release, orphaned objects cannot be viewed by any non-superuser. + +Customers have told us that this behavior is overly restrictive. You can maintain this behavior by unchecking the two options above. However, the default will be to leave these unchecked so that orphaned objects are visible to everyone. + +The “Building hierarchy” option applies to building hierarchy objects, specifically buildings, rooms, racks, devices, assets, and pdus. For example, if this option is checked, a non-super can view and change any building that has no groups assigned to it AND can view and change any room, rack, device, asset or pdu in the building. The “IP hierarchy” option applies to IP addresses and subnets. For example, if this option is checked, a non-super can view and change any subnet that has no groups assigned to it or to a parent subnet. + +The “Other objects” option applies to purchases and customers. For example, if this option is checked, a non-super can view and change any purchase that has no groups assigned to it. + +  diff --git a/docs/apps/application-components/index.md b/docs/apps/application-components/index.md new file mode 100644 index 00000000..860f8e33 --- /dev/null +++ b/docs/apps/application-components/index.md @@ -0,0 +1,39 @@ +--- +title: "Application Components" +--- + +Application Components are intended to capture what people generally think of as "Applications." An application might be a CEO Dashboard that requires a web server/farm, an app server, and a database server. An application component might also be linked to just one service. Or an application component might be defined without any underlying service. + +### Defining Application Components Based on Services + +Each Service Instance edit form has an option to link that service with an Application Component. + +![service-to-app.png](/assets/images/service-to-app.png) + +In the example above, we've linked the oracle\_proce233442 service with the "Oracle Server 0006" Application Component. + +If you navigate to the edit form for an Application Component, you can also link one or more services from that screen: + +![service-to-app-2.png](/assets/images/service-to-app-2.png) + +### Defining Application Components Not Based on Services + +![](/assets/images/Application-Component-View-List.png) + +Device42 now automatically categorizes application components by the following categories: Database, Application Layer, Web Server, Load Balancer, and Other. You can filter the list page based on application component category, and can categorize your custom components as well. + +The _Application Component_ view page now also includes a _Has Resource_ column that displays the name of the associated resource for an application component. + +![wpid2068-Defining_Application_Components_bottom_UP.png](/assets/images/wpid2068-Defining_Application_Components_bottom_UP.png) + +In the example above, we are defining a "SAN Store" that depends on a device named "sh-SAN-Cluster01". If we'd like, we can also identify the Responsible Department, and choose which organizational groups are affected by this application component. + +Next we will define an "exchange server" component as shown below. + +![wpid2071-media_1334740220432.png](/assets/images/wpid2071-media_1334740220432.png) + +Then we will add an Outlook Web Access(OWA) component that depends on the Exchange component as shown below: + +![wpid2072-media_1334740452246.png](/assets/images/wpid2072-media_1334740452246.png) + +All of the dependencies we just created will show up in impact charts, impact lists, and dependency graphs. diff --git a/docs/apps/business-applications/index.md b/docs/apps/business-applications/index.md new file mode 100644 index 00000000..cf42aa55 --- /dev/null +++ b/docs/apps/business-applications/index.md @@ -0,0 +1,173 @@ +--- +title: "Business Applications" +--- + +## Using Business Applications + +Device42 Business Applications offers a powerful way to build custom maps of business critical functions. Besides looking different than [Affinity Groups](apps/affinity-groups/index.md), Business Applications are also different because they are not automatically built out based solely on discovered connections and devices. Business Applications can be totally designed and customized by you, and can _include any and all of the resources that you identify as critical to your business!_ + +Using Business Applications, you'll be able to catalog all of your business and mission-critical applications. All of the following are possible: + +- Creating Business Applications from scratch or from existing Affinity Groups +- Adding and removing devices and connectivity +- Customizing the resource layout, connections, and their labels +- Saving customized layout(s) and returning to edit them at any time + +* * * + +- Select _Applications > Business Applications_ from the Device42 menu to display a list of existing applications. + +![](/assets/images/D42-23306_biz-app-list-page.png) + +- Click on a Business Application _Name_ to view details about the application. + +![](/assets/images/D42-23306_biz-app-view-page.png) + +**Note:**  Business Applications display information about any Devices and Application Components associated with the Business Application. (Device42 automatically categorizes application components as Database, Application Layer, Web Server, Load Balancer, or Other.) Application Component information also appears on the Business Application visualization canvas (see below). + +- Click _View Application_ to see the visualization of the application.  Click the _Edit_ button at the top right to turn edit mode on. + +![](/assets/images/D42-23306_biz-app-canvas.png) + +The page displays the business application name; hover over _Application Details_ to see information about the application. The left panel contains icons for adding devices, affinity groups, or application components to your business application and a menu bar above the icons.  You can also now run a _Service Dependencies Report_ for the Business Application, which details all the communications for the devices within the Business Application. + +Click a device, affinity group, or application component object on the canvas to see details about that item. Links in the details box or below the object take you to the view pages for those items. + +![](/assets/images/D42-23306_biz-app-object-details.png) + +## Add a Business Application + +- Select _Applications > Business Applications_ from the Device42 menu to display the applications list, and then click _Add Business Application_. + +![](/assets/images/D42-23306_biz-app-add-page.png) + +- Enter the application _Name_ and select the _Application Type_ (COTS, COTS with Customization, or Custom) and add a _Description_ if wanted. +- Use the magnifying glass icons to select or enter the _Technical Application Owner_, _Business Application Owner_, and _Responsible Customer or Department_. +- Use the format **1w 2d 3h 4m 5s** (1 week, 2 days, 3 hours, 4 minutes, and 5 seconds) to denote the time period for _DR Recovery Point Objective_ and _DR Recovery Time Objective_. The individual terms are optional and numbers must be integers. For example, you can enter **2d 6h** to define two days and six hours. +- Select or enter the _Migration Group_ and _Criticality_, and add any _Notes_ or _Tags_ you want. +- Click _Save_ at the bottom right of the page to save the application and add it to the applications list page. + +**Note**: To edit an existing application, click its _Name_ in the business applications list page, and then click _Edit_. + +![](/assets/images/D42-23306_biz-app-edit-page.png) + +## Add or Edit Business Application Visualizations + +- Select _Applications > Business Applications_ to display the Business Applications list, select an application _Name_, and then click _View Application_. +- Device42 displays the visualization canvas.  Click the _Edit_ button at the top right to turn edit mode on. + +![](/assets/images/D42-23306_biz-app-add-resource-1.png) + +### Add Devices + +- To add a device to a business application, drag a _Device_ block to the canvas – this will open the Add Device box.  You can _Search_ for a device by the device name, service level, tag, or service name. +- Select a device from the list, and then click **Add**. Device42 adds the device to the canvas. + +![](/assets/images/D42-23306_biz-app-add-device-popup.png) + +### Add Affinity Groups + +- To add an affinity group to an application, drag an _Affinity Group_ block to the canvas – this will bring up the Add Affinity Group box.  You can _Search_ by group type, group name, tag, primary device name, or service name +- When you click on a group in the list, you will see the number of devices in that group. +- Select an affinity group from the list, and then click **Add**. Device42 adds the Affinity Group with all its devices and connections to the canvas. + +![](/assets/images/D42-23306_biz-app-add-affinity-group-popup.png) + +### Add Application Components + +- To add an application component to a business application, drag a _Application Component_ block to the canvas – this will open the Add Application Component box.  You can _Search_ for a component by its name or its device name. +- Select a component from the list, and then click **Add**. Device42 adds the application component to the canvas. + +![](/assets/images/D42-23306_biz-app-add-app-comp-popup.png) + +### Delete a Device + +To delete a device (or other objects on the canvas), either select the device and press the _Delete_ key, or right-click on a selected device and select _Delete_ from the context menu. + +![](/assets/images/WEB-542_BusinessApps-Canvas-Ex-3-PopupMenu.png) + +**Note**: Removing a device does not remove connections on the canvas, nor does it affect calculated information stored in Affinity Groups. + +### Rename a Device + +To rename a device (or other objects on the canvas), select the device, double-click the device name, and type a new name. + +**Note:** The name change does not change the device record and is only for display in this specific Business Application visualization. + +## Add or Edit Connections in a Visualization + +You can add and edit connections between object on the canvas. + +1. Hover over a device object to display the object’s connection points (green dots). Click a green dot and drag the connection to a point on any other object. ![](/assets/images/WEB-542_BusinessApps-Canvas-Ex-4-ConnectorPoint.png) +2. To delete a connection, select the connection and press the _Delete_ key, or right-click and select _Delete_ from the context menu. + +**Note:** Deleting a connection does not affect calculated information stored in Affinity Groups. + +### Name Connections + +To name connections, simply click on the connection itself and type the description or name for the connection. + +## Save a Business Application Visualization + +Click the _File_ menu at the top of the canvas and select _Save_. + +![](/assets/images/BusApps-canvas-6-file-save.png) + +## Clone or Delete Business Applications + +### Clone a Business Application + +From the Business Applications list page, you can easily clone an existing Business Application. You might want to do this to experiment without editing the original, or as the base of a new Business Application, or even to plan out a future deployment or migration. Follow these steps: + +- Select _Applications > Business Applications_ to display the Business Applications list, select the checkbox for the application you want to clone, and then click _Clone Business Application_. + +![](/assets/images/D42-23306_biz-app-clone-ba.png) + +- Click the _Business Application to clone_ magnifying glass to select (or search for) the application you want to clone. +- Enter the _\# of Business Applications_ to make and the name or names (_Comma separated names_) to give the newly cloned Business Applications and click _Clone_. + +### Delete a Business Application + +- Select _Applications > Business Applications_ to display the Business Applications list, and select the checkbox for the application you want to delete. +- Select _Delete selected Business Application_ from the Actions menu and click the blue lightning bolt. + +## Exporting a Business Application for Migration + +You can export Business Applications directly for migration by 3rd-party migration software suites. Device42 currently supports export to Microsoft Azure, RiverMeadow, and Carbonite. + +### Exporting to Carbonite Migrate + +Device42 can export one or more of your business applications directly to Carbonite Migrate. + +### Exporting to Microsoft Azure Migrate (cloud migrations) + +Device42 can export one or more of your business applications directly to the Microsoft [Azure cloud platform](https://portal.azure.com/#home) via [Azure Migrate](https://azure.microsoft.com/en-us/services/azure-migrate/). + +For detailed instructions on [how to export a business application to the Azure cloud](integration/external-integrations/azure-migrate.md), go to the dedicated [Azure Migrate integration page](/external-integrations/azure-migrate/), at [Azure migrate](integration/external-integrations/azure-migrate.md). + +### Exporting to RiverMeadow Data Migration + +- Select _Applications > Business Application_, and then select the check boxes for the applications you want to migrate. + +![](/assets/images/D42-23306_biz-app-select-migration-menu.png) + +- Select _Create Migration for Selected Objects_ from the Action menu and click the blue lightning bolt. +- This will bring you to the Create Migration Export page. Select _RiverMeadow CSV_ from the _Choose target for migration_ drop-down, and click _Export_ button to export a CSV file with the IP address(es) and credentials for the server instance(s) that power your chosen Business Applications. + +![](/assets/images/D42-23306_biz-app-select-migration-report.png) + +- Save the exported CSV, and then open it using RiverMeadow to perform your migration. + +Support for more migration software is being added and will be released shortly. Should you have any questions, please contact [support@device42.com](mailto:support@device42.com). + +* * * + +## Accessing Business Applications through DOQL + +Business applications information is available through our query language (DOQL). + +The following views support the applications and relationships in Business Applications: + +- `view_businessapplication_v1` +- `view_businessapplicationelement_v1` +- `view_businessapplicationconnection_v1` diff --git a/docs/apps/enterprise-application-dependency-mapping/index.md b/docs/apps/enterprise-application-dependency-mapping/index.md new file mode 100644 index 00000000..989683b3 --- /dev/null +++ b/docs/apps/enterprise-application-dependency-mapping/index.md @@ -0,0 +1,12 @@ +--- +title: "Application Dependency Mapping" +--- + +_The Application Dependency Mapping module allows Device42 to autodiscover application dependencies and service dependencies on a deeper level throughout your network._ + +## **ADM Module Features include:** + +- **Discover services to services mappings**: Device42 can show you which service on a machine/instance is connected to what other service(s) on other machines. +- **Automatic app component grouping**: auto-add application components based on groupings of services on a server. For example, once we discover different Oracle services running on a machine, those will be automatically grouped together as an Oracle application. +- **Grab the configuration data for major applications**: e.g. Oracle, Microsoft SQL, MongoDB, PostgreSQL, MySQL, Cold Fusion, IIS and Apache httpd, etc. With this, you are able to see config details (and for some software, the actual configuration file contents) for the applications from within Device42. + diff --git a/docs/auto-discovery/database-discovery/index.md b/docs/auto-discovery/database-discovery/index.md new file mode 100644 index 00000000..febc9d6a --- /dev/null +++ b/docs/auto-discovery/database-discovery/index.md @@ -0,0 +1,298 @@ +--- +title: "Database Discovery" +--- + +## About Database Discovery + +Database discovery was introduced in v16.02.00 _(ensure you are running v16.02+)_, and currently supports Windows and \*nix-based discovery jobs to discover Microsoft SQL (aka MSSQL), Oracle, Postgres SQL, and DB2 databases. + +**Note**: Database discovery requires an **Enterprise Application Discovery** license. Go to _Tools > Settings > Licensing_ to see if the license is enabled. Contact [support@device42.com](mailto:support@device42.com) for licensing assistance. + +As of v16.17.00, Device42 supports MSSQL and Oracle database discovery for customers that have database instances configured to listen on non-standard ports, especially on a shared database server hosting multiple instances. During database discovery, Device42 will identify and connect through the discovered active listening port. + +You can also use [Database Connections Discovery](auto-discovery/database-discovery/#section-19) jobs (see below) to discover databases. + +## MS SQL Server DB Discovery (on Windows targets) + +Microsoft SQL Server (MSSQL) discovery is supported on discovery targets running Microsoft Windows, and requires a separate set of credentials to authenticate to the database instance itself. Ensure these credentials have appropriate permissions to view the databases you are interested in discovering. + +Device42 supports autodiscovery on Windows and \*nix platforms for the following MSSQL versions. + +- MSSQL 2005 +- MSSQL 2008 +- MSSQL 11 on SQL Server 2012 +- MSSQL 12 on SQL Server 2014 +- MSSQL 13 on SQL Server 2016 +- MSSQL 14 on SQL Server 2017 +- Cluster MSSQL 12 + +### Minimum Permissions Requirements for MSSQL Discovery + +In order to query the below tables, please ensure you have **View Server State** permissions. For discovery to return detailed info about your database instance, you will require read permissions to the following system views: + +
  • sys.dm_exec_connections
  • sys.dm_exec_sessions
  • sys.databases
  • sys.master_files
  • sys.tables
  • sys.dm_os_sys_info
  • sys.dm_os_sys_memory
+ +The snippet shown below is necessary to get data from some of the preceding views even if the user has read permissions (_sys.master\_files_, for example). + +1 use \[master\] +2 GO +3 grant VIEW any DEFINITION TO \[discovery\_user\] +4 GO + +**Note**: The discovery user must belong to the administrators user group to discover databases successfully. + +### Setting up your MSSQL discovery job + +1) To begin discovering your MSSQL Databases \[running on Windows\], create a new Windows discovery job and be sure to enable database discovery by checking the _Collect database server information_ checkbox. Select _Allow Unencrypted Connections_ if you want to discover MSSQL 2005 or MSSQL 2008 databases. + +![](/assets/images/D42-21939_Unencrypted-conns-for-SQL-db-2.png) + +Be sure to fill out both sets of credentials – the first set (_Database Username / Password_) to authenticate to the Microsoft SQL database itself and the second (_Discovery Targets Credentials_) to authenticate to the Windows server itself (like you’re used to for [regular Windows-based discovery targets](auto-discovery/windows-and-hyper-v-auto-discovery/)). + +You can enter an ordered list of preferred _Discovery Target(s) Credential(s)_ when you create a database discovery job. When the job runs, it will use the credentials in the order in which you enter them, stopping at the first successful authentication. Subsequent job runs use the last successful credential and then the remaining credentials in the ordered list. + +![](/assets/images/D42-21939_Unencrypted-conns-for-SQL-db-3-preferred-creds.png) + +* * * + +![Example job status](/assets/images/discovery-job-status-trimmed.png) + +2) Kick off your new discovery job to test it (select "Run now" on the Job Screen). As MSSQL databases are detected, discovery will import a list of all instances, databases, and connection details. You can see the status of the discovery job on the job's setup page, as well - Scroll down to the "Job Status" section and look for the bar graphs. + +### Viewing MSSQL discovery job results + +3) Once the job finishes, you can view the results of your database discovery. + +There are a couple different ways to see the database details; the most direct is via the discovered MSSQL Application components themselves. Head to the Device42 main menu, Apps menu -> Application Components. If you don't see your SQL Server instances right at the top of the list, you can search for "SQL" to narrow the list down. + +You can see the newly discovered SQL Server instances in the example below -- Click any one of the Application Component Names for more details: ![MSSQL Application Componenets](/assets/images/Apps-Application-Components-menu-annotated.png) + +Scroll to the bottom, and click the database instance name to view database details: ![](/assets/images/click-to-view-SQL-details.png) + +For a rundown of the database details discovery provides, jump to the ["Available SQL database instance information"](auto-discovery/database-discovery/#section-6) section. + +### Another way to view SQL Database details + +Results are also available by browsing to the discovered Windows server instance's CI; either search for the device from the dashboard, via "Devices -> All Devices", or view your discovery job's results / score page and jump to the servers from there: ![](/assets/images/click-success-for-discovery-scores.png) + +Click any of the "device names" (right hand side) to jump to each discovered machine's details view. From the details view, you can simply click the "Services" tab to view a list of services, and can then click on the Microsoft SQL Server instance in that list. ![](/assets/images/discovery-score-to-view-1.png) + +### Available SQL database instance information + +On the "View Database Instance" screen, you will see lists containing the following items: + +- Databases on that instance _(each clickable for individual DB connection & size stats)_ +- Connections to that DB instance _(connection details available for each connection)_ +- Database size details, creation date, and path +- Extra details, including server start time, CPU count, Memory info, and more + +If your environment includes SQL cluster databases, discovery returns the following information about the clusters: + +- SQL Cluster name +- SQL Cluster Node Role +- Is Node Active or Read-Replica +- Does Passive Node use Log Ship +- Does Passive Node use DB Mirroring + +A snippet from each section of the page can be seen below: ![](/assets/images/database-list.png) ![](/assets/images/DB-Connection-Details.png) ![](/assets/images/database-size-details.png) ![](/assets/images/extra-DB-details.png) + +## Oracle DB Discovery (on Windows and \*nix targets) + +Oracle database discovery (introduced in v16.04.00) is supported for Windows an \*nix discovery targets, and requires a separate set of credentials to authenticate to the database instance itself. Ensure these credentials have appropriate permissions to view the databases you are interested in discovering. + +As of v16.14.01, Device42 now supports autodiscovery on Windows and \*nix platforms for the following Oracle database versions. + +**Oracle 10g** + +- Windows 32 bit +- CentOS 32 bit + +**Oracle 11g** + +- Windows 32 bit +- Windows 64 bit +- CentOS 32 bit +- CentOS 64 bit + +**Oracle 12c** + +- Windows 64 bit +- CentOS 64 bit + +**Oracle 18c** + +- CentOS 64 bit +- Windows 64 bit + +**Oracle 19c** + +- Windows 64 bit +- CentOS 7 64 bit + +As of v16.17.00, Device42 database autodiscovery for Windows and \*nix targets supports discovery for Oracle RAC clustered database environments. This will help users better assess their cluster databases and will enable users to better understand all IT assets that are tied to critical business applications. Discovery returns data about the RAC configuration, the RAC database, and the nodes (physical servers) running the RAC software. You can run the autodiscovery against one or more nodes in the Oracle RAC and return information about all connected nodes. We require the use of sudo for Oracle discoveries, without it lockout is a risk. + +### Minimum Permissions Requirements for Oracle Discovery + +For discovery to return detailed info about your database instance, you will require read/view permissions for the following system views/tables: + +
  • V$SESSION
  • DBA_SEGMENTS
  • DBA_OBJECTS
  • SYS.ALL_USERS
  • DATABASE_COMPATIBLE_LEVEL
  • SYS.PRODUCT_COMPONENT_VERSION
+ +### Setting up your Oracle discovery job + +1) To begin discovering your Oracle databases, create a new discovery job for Windows or \*nix (or both) targets, and be sure to check the _Collect database server information_ checkbox. + +Be sure to fill out both sets of credentials – the first set (_Database Username / Password_) to authenticate to the Oracle database itself and the second (_Discovery Targets Credentials_) to authenticate to the Windows or \*nix server itself. + +You can enter and ordered list of preferred _Discovery Target(s) Credential(s)_ when you create a database discovery job. When the job runs, it will use the credentials in the order in which you enter them, stopping at the first successful authentication. Subsequent job runs use the last successful credential and then the remaining credentials in the ordered list. + +![](/assets/images/D42-21939_Oracle-db-discovery.png) + +2) Kick off your new discovery job to test it (select **Run Now** on the Jobs screen). As Oracle databases are detected, discovery will import a list of all instances, databases, and connection details. + +![](/assets/images/Oracle-Discovery-1a-3.png) + +### Viewing Oracle DB discovery job results + +3) Once the job finishes, you can view the results of your database discovery. There are a couple different ways to see the database details; the most direct is via the discovered Oracle Application components themselves. On the the Device42 main menu, select **Apps -> Application Components**. If you don't see your Oracle DB instances right at the top of the list, you can search for _Oracle_ to narrow down the list. + +![](/assets/images/Oracle-Discovery-2a-4.png) + +Use the View Database Instances screen to view a list of discovered databases. + +![](/assets/images/Oracle-Discovery-7-DB-Instance.png) + +Scroll down through the screen to see a list of database connections and sizes. + +![](/assets/images/Oracle-Discovery-7a-DB-Connections.png) + +![](/assets/images/Oracle-Discovery-7b-DB-Sizes.png) + +You can also click on the database name on the View Database Instances screen to see its connection and size data. + +![](/assets/images/Oracle-Discovery-7c-DB-ByName.png) + +On the Application Components screen, click **Show** to view the database Dependency Chart or an Impact Chart or List. + +![](/assets/images/Oracle-Discovery-5-Dependency-Chart.png) + +![](/assets/images/Oracle-Discovery-3a-4.png) + +## Postgres SQL DB Discovery (on \*nix targets) + +Postgres SQL database discovery (introduced in v17.11.00) is for \*nix discovery targets, and requires a separate set of credentials to authenticate to the database instance itself. Ensure these credentials have appropriate permissions to view the databases you are interested in discovering. + +### Minimum Permissions Requirements for Postgres SQL Discovery + +For discovery to return detailed info about your database instance, you will need access to tables: + +
  • pg_database
  • pg_tablespace
  • pg_stat_activity
  • pg_stat_activity
  • init_server_addr (function)
+ +### Setting up your Postgres SQL discovery job + +1) To begin discovering your Postgres SQL databases, create a new discovery job for \*nix targets, and be sure to enable database discovery by checking the _Collect database server information_ checkbox. + +Be sure to fill out both sets of credentials – the first set (_Database Username / Password_) to authenticate to the Postgres database itself and the second (_Discovery Targets Credentials_) to authenticate to the \*nix server itself. + +You can enter and ordered list of preferred _Discovery Target(s) Credential(s)_ when you create a database discovery job. When the job runs, it will use the credentials in the order in which you enter them, stopping at the first successful authentication. Subsequent job runs use the last successful credential and then the remaining credentials in the ordered list. + +![](/assets/images/D42-23580_Postgres-ad-job-edit-page.png) + +2) Kick off your new discovery job to test it (select **Run Now** on the discovery jobs screen). As Postgres databases are detected, discovery will import a list of all instances, databases, and connection details. + +### Viewing Postgres SQL DB discovery job results + +3) Once the job finishes, you can view the results of your database discovery. There are a couple different ways to see the database details; the most direct is via the discovered Postgres application components themselves. On the the Device42 main menu, select **Applications -> Application Components**. If you don’t see your Postgres DB instances right at the top of the list, you can search for _Postgres_ to narrow down the list, or filter the list _By Category > Database_. + +![](/assets/images/postgresSQL.jpg) + +  + +  + +  + +You can also select _Resources > Databases > On-Prem Databases_ to display a list of databases. + +![](/assets/images/AD2-700x407.png) + +## DB2 Discovery (on \*nix targets) + +DB2 database discovery (introduced in v18.02.00) is for \*nix discovery targets, and requires a separate set of credentials to authenticate to the database instance itself. Ensure these credentials have appropriate permissions to view the databases you are interested in discovering. + +### Setting up your DB2 discovery job + +1) To begin discovering your DB2 databases, create a new discovery job for \*nix targets, and be sure to enable database discovery by checking the _Collect database server information_ checkbox. + +Be sure to fill out both sets of credentials – the first set (_Database Username / Password_) to authenticate to the DB2 database itself and the second (_Discovery Targets Credentials_) to authenticate to the \*nix server itself. + +You can enter and ordered list of preferred _Discovery Target(s) Credential(s)_ when you create a database discovery job. When the job runs, it will use the credentials in the order in which you enter them, stopping at the first successful authentication. Subsequent job runs use the last successful credential and then the remaining credentials in the ordered list. + +![](/assets/images/D42-25010_nix-AD-job-with-db.png) + +### Viewing DB2 discovery job results + +3) Once the job finishes, you can view the results of your database discovery. Discovered DB2 databases are added to the On-Prem Databases list page. On the the Device42 main menu, select _Resources -> Databases > On-Prem Databases_ to display the page. If you don’t see your DB2 instances, you can search for _DB2_ to narrow down the list. + +![](/assets/images/SA-4-delete-confirm-700x305.png) + +Click the _Resource Name_ to see more information about that database. + +![](/assets/images/placeholder.png) + +## Database Connections Discovery Jobs + +Device42 v18.01.00 adds a new Database discovery job type that you can use to discover information about databases in your environment. Database discovery is based on database connection information – including application components and DB server details – you supply for the job. Returned database information is added to the On-Prem Databases list page. + +**Note**: If you have already discovered cloud databases using cloud autodiscovery jobs, and you then perform a Database Connections discovery using FQDN, Device42 will not duplicate the databases (which was the previous behavior). + +- Select _Discovery > Database_ from the main menu to display the Database discovery list page. + +![](/assets/images/D42-26290_alerts-job-interval-700x168.jpg) + +- Click on a Database discovery _Name_ to view that job. Click _+Add_ at the top right of the page to add a new Database discovery job. + +![](/assets/images/placeholder.png) + +- Click _Edit_ at the top right of the page to edit an  existing job. Click _+Add More_ to add additional Database Connection information for the job. + +![](/assets/images/D42-25010_db-AD-job-1.png) + +- Enter or select the Database Connections information. + - **Name** – Connection name + - **Application Component** – Application Component to link to + - **Platform** – Database type: Oracle, MS SQL, or Postgres + - **Server** –  IP address of the DB server + - **Port** – DB server port + - **Credential** – DB server access credentials + - **Extra** – DB-type specific: _Instance_ for Oracle, _Database_ for Postgres and DB2 +- Use the _Trash_ icon to remove a Connections line. +- Scroll down the page to add or edit the _Discovery Schedule_ for the job. +- Click _Save_ to save the job. + +### Database Discovery Job Scores + +You can view Discovery Scores for Database jobs that have run. + +- Select _Analytics > Discovery Status > Discovery Scores_ to display the Scores list page. + +![](/assets/images/18.04.00_EnrichAI_data-list-page-700x336.jpg) + +- Click the _Discovery Target_ link for the job you want to see. + +![](/assets/images/18.04.00_EnrichAI_data-view-page-os-700x274.jpg) + +- Click _Detailed Discovery Scores_ to see additional information. + +![](/assets/images/18.04.00_EnrichAI_data-view-page-vendor-700x270.jpg) + +### View Discovered Databases + +Discovered databases are added to the On-Prem Databases list page. + +- Select _Resources > Databases > On-Prem Databases_ to display the list page. + +![](/assets/images/placeholder.png) + +- Click the _Resource Name_ of the database you want to see. + +![](/assets/images/placeholder.png) diff --git a/docs/auto-discovery/resources/index.md b/docs/auto-discovery/resources/index.md new file mode 100644 index 00000000..091ebc74 --- /dev/null +++ b/docs/auto-discovery/resources/index.md @@ -0,0 +1,64 @@ +--- +title: "Resources" +--- + +## Introduction + +Managed Resources are items identified and returned by Device42 autodiscovery jobs, and can be both cloud-based or on-premise. Managed resources include devices, load balancers, pool resources, storage arrays, etc. Managed resources also display their resource details, related resources, and topography map. + +## View All Resources + +Select _Resources > All Managed Resources_ from the Device42 menu to display the resources list. + +![](/assets/images/Resources-1-Menu-Item.png) + +Device42 displays the Resources list page. On this page, you can _Search by name_, or filter the list by _Cloud Provider_ or _Vendor Resource Type_. + +![](/assets/images/Resources-2-1-List-Page.png) + +You can also click _+More_ to filter by _Vendor Resource Subtype_, _Regions_, _Zones_, _Tags, In Service, Service Level,_ _First Added_, and _Last Updated_. + +![](/assets/images/Resources-4-More-Menu.png) + +**Note**: The Managed Resources list page also includes an _Advanced Search_ option you can use to construct more specific searches. See the [Advanced Search Feature](getstarted/advanced-search-feature.md) documentation page for instructions. + +Click on a resource _Name_ to see details about that resource. You can use the links in the _Related Resources_ panel on the right to see details about that related resource. + +![](/assets/images/Resources-2-2-View-Page.png) + +![](/assets/images/Resources-10-Related-Resources-link-example.png) + +Click _Resource Map_ at the top left of the page to see the topography map for the resource. You can select which _Resource Types_ you want to include in the map. + +![](/assets/images/Resources-2-3-Map-Page.png) + +## Edit Resources + +Click _Edit_ on the Resources view page to edit the resource. You can add or edit _Notes_ or _Tags_ for the resource, select Yes/No for _In Service,_ and select or add a _Service Level_ value_._ + +![](/assets/images/Resources-2-4-Edit-Page.png) + +  + +Click _Save_ to save your edits; click _Cancel_ to discard them. + +## Select Resources Across Multiple Pages + +You can select resources across multiple list pages to apply Action Menu commands (such as _Delete Resources_ below) to the selected resources. + +- Select _Resources > All Resources_ from the Device42 menu to display the resources list. +- Apply any filters you want to the list. +- Select a list page you want to view and then select resources on that page. The page shows you how many items you selected. +- Select a different list page and then select resources on that page. The page updates the selected items count. You can then apply Action Menu commands to all the selected items. + +![](/assets/images/D42-18414_select-resources-across-pages-1.png) + +## Delete Resources + +Select one or more resources from the list, and select either _Fast Background Delete_ or _Delete with Detailed Confirmation_ from the Actions menu, and then click the lightning bolt icon. + +![](/assets/images/Resources-3-Action-Menu.png) + +Confirm the deletion if prompted. + +![](/assets/images/Resources-3-Action-MenuDelete-Confirm.png) diff --git a/docs/getstarted/faqs/_category_.yml b/docs/getstarted/faqs/_category_.yml new file mode 100644 index 00000000..ad968574 --- /dev/null +++ b/docs/getstarted/faqs/_category_.yml @@ -0,0 +1,4 @@ +position: 0.5 +label: 'FAQs' +collapsible: true +collapsed: true diff --git a/docs/getstarted/faqs/index.md b/docs/getstarted/faqs/index.md new file mode 100644 index 00000000..7d517ada --- /dev/null +++ b/docs/getstarted/faqs/index.md @@ -0,0 +1,104 @@ +--- +title: "FAQ's" +--- + +Whether you're new to Device42 or a seasoned pro, this list of **Device42 frequently asked questions** probably has information you'll find useful. This list is updated pretty regularly, and contains a selection of the questions most often asked about Device42. + +If you've just downloaded Device42 for the first time and are looking for help getting up and running, please refer to our [getting started guide](getstarted/index.md) if you're looking for help getting your instance up and running. The getting started guide is tailored to new users, specifically. + +## How do I log into my Device42 instance? + +With a default configuration, visit: `https://IP_or_fqdn_for_device42_vm` in your favorite web browser, and then log in by entering the following \[default\] credentials: Default user: `admin` Default pass: `adm!nd42` + +## Which browser should I use? + +Device42 recommends using the web browsers (or more recent versions) listed below. + +- Chrome — 88.0.4324.150 +- Edge — 88.0.705.63 +- Firefox — 72.0.1 +- Safari — 13.1.2 (13609.3.5.1.5) + +## How do I get my current data into Device42? + +**There are many ways to get your data into Device42**: + +- [**Device42 Auto-discovery**](auto-discovery/index.md): D42 features a variety of autodiscovery methods, the best of which depends on your needs: SNMP network device discovery, VMware auto-discovery, ping sweep, Windows and Linux auto-discovery, and more; you may also use individual python/powershell scripts to customize & automate your discovery and/or inventory process. Read about the [recommended initial discovery sequence](auto-discovery/autodisc-best-practices.md) here, as well! +- [**Microsoft Excel / CSV (spreadsheet) import**:](integration/imports/index.md) _Tools > Imports/Exports (xls)_ has options for MS Excel spreadsheet import, including sample Excel sheets that will help you format your existing spread sheets to make bringing your existing data into Device42 as easy as possible. +- The [**Device42 Generic Import Tool**](https://www.device42.com/blog/2018/06/new-features-added-to-the-generic-import-tool/) is another way to import data from existing spreadsheets of just about any format, mapping fields as appropriate via the Device42 generic import tool. For manual spreadsheet import, see this [walkthrough on how to best format an existing spreadsheet for import into Device42.](getstarted/importing-data-from-existing-spreadsheets.md) +- [**RESTful APIs**](https://api.device42.com): Programatically automate your network documentation and/or leverage your asset data for scripts & automation! Add these to your regular work flow to leverage Device42 as single source of truth for systems such as provisioning and monitoring. +- [**API-based CSV Import**](integration/api-overview/importing-csv-files-into-d42-using-the-api-helper-utility.md): This API helper utility is perfect if you aren't feeling the Excel import option _(or for any other reason!)_. This Python-based CSV utility makes it easy to feed just about any CSV to Device42's RESTful APIs. +- The **Device42 Web UI**: Of course, you can always use the web-UI _(user interface)_ to add data :) +- **Templates/bulk operations**: Certain types of objects are easier to add using templates or models. For example, [PDU models](infrastructure-management/power-units/defining-pdu-models.md) to create PDUs, [Switch port templates](infrastructure-management/ipam/switch-templates.md) to create switches and ports, [Patch panel models](infrastructure-management/power-units/defining-pdu-models.md) to create patch panel ports and bulk back port connectivity for patch panels. + +## What is the recommended order for running different discoveries? + +See the "Recommended Initial Discovery Sequence" section of the [autodiscovery best practices](/auto-discovery/autodisc-best-practices/) page for a full detailed rundown. + +**In short**: run network discovery first to build your Layer 2 network landscape. Discovered devices, going forward, are added to their appropriate subnets as they are discovered -- _Note that if device discoveries are run before the subnets for those devices exist in Device42, you might run into issues and/or create extra work for yourself!_ + +## How do I set up an RC / Remote collector? + +Setting up a remote collector is easy! See the [RC Setup Instructions](auto-discovery/remote-collector-rc.md) which include deployment examples. + +## How do I migrate my existing data from other tools? + +We provide few ready to use scripts to migrate your data from tools like RackTables, Rackmonkey, OpenDCIM, Solarwinds IPAM, Aperture etc. and the download links can be found at [Device42 Migration page](https://www.device42.com/migrations/) or at [Device42 github repository](https://github.com/device42). + +## What discovery jobs can I run from a Remote Collector / RC? + +Current releases of Device42 support ALL discovery jobs, now including WMI & Power SNMP from RC's. If you are reading this, all of them! [Setup your RC](auto-discovery/remote-collector-rc.md) today! (RC will only automatically update when it coincides with an MA update) + +## How do I Migrate Existing Power Appliance Jobs to a Remote Collector (RC)? + +Migrating jobs that were created for the original standalone power appliance is possible with existing tools. Simply follow the [existing power job migration guide here](/energy-monitoringmanagement/power-rc-setup-job-migration/) to migrate jobs to the new RC of your choice. + +## How do I add blade servers to Device42? + +This topic has been discussed on support portal : [How to represent blade servers in Device42?](https://device42.zendesk.com/entries/23369387) tldr; Add a new device with "blade chassis" selected. Then you add devices, type "blade", and choose the blade chassis device as the host device. _Note that blade chassis accept blades in "blade slots", which you can custom-configure to match your chassis & port layout!_ + +## How do I handle unknown device types? + +![Change type for selected devices, re-classify unknown devices](/assets/images/view-devices-change-selected-device-type.PNG) + +During initial device discovery, some of devices will show up as type "unknown". This can be fixed using: + +- Changing the associated hardware model would change all associated devices - current and future. This can be done from Data Center > Hardware or Tools > Templates & Bulk Operations > Bulk Hardware edit. +- From Devices > All Devices. You can filter for type "unknown" and bulk change the device type. +- You can export unknown devices in excel format from Reports > Reports > Add report > Device. Edit the excel file to match Tools > Import > Device Import. Change the type and import the excel file. +- Make the change using REST APIs. + +## How can I create reports? + +Data can be exported in excel or csv format using: + +- Reports > Reports > Add Report. +- Reports > Generate Run Book +- Tools > Exports (CSV) +- Tools -> Imports/Exports to download current data. + +## How do I backup my data? + +Device42 appliance manager runs at https://your\_device42\_ip\_or\_FQDN:4242/ Default username password is d42admin/default You can create backup from Backup/Restore > Backup now. + +This is also discussed under section : [appliance manager.](/administration/appliance-manager/) + +## How do I update to the latest release? + +1. Download the latest release update file from [Device42 update page](https://www.device42.com/update/) +2. From the D42 main menu: _Tools > Update;_ Click _"Link to Appliance Manager"_, then browse to the downloaded update file ; Click "Upload". +3. Choose Option #3 on the Main Appliance's VM console to apply the update; follow the on-screen prompts. + +This is also detailed on the support portal: [D42 Upgrade steps.](https://device42.zendesk.com/entries/21783332) + +For more information about Main Appliance and Remote Collector updates, see the  [Main Appliance and Remote Collector](/administration/appliance-manager/) page. + +You can subscribe to the [Device42 Blog rss feed](https://www.device42.com/blog/feed/) or follow us on [twitter](https://www.twitter.com/device42) to get immediate notifications for new releases. + +## How do I Install Device42 xen/kvm appliance if import existing disk image option is missing? + +If you are trying to install the Device42 appliance on Xen or KVM based platforms, but the import disk image option is missing, see our page [Installing Device42 Appliance but Import to disk is missing](/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing/) + +## Where can I get help with something not covered here? + +We always recommend searching the [Device42 support portal](https://device42.zendesk.com/) when faced with a question that doesn't seem to be addressed in our documentation. That said, if you do find one, or get stuck, go ahead and open a support ticket. Send a note to support@device42.com or visit the 'support' tab at the top of this page. diff --git a/docs/getstarted/faqs/main-appliance-remote-collector-faq.md b/docs/getstarted/faqs/main-appliance-remote-collector-faq.md new file mode 100644 index 00000000..9b00cf75 --- /dev/null +++ b/docs/getstarted/faqs/main-appliance-remote-collector-faq.md @@ -0,0 +1,33 @@ +--- +title: "Main Appliance & Remote Collector FAQ" +--- + +## How do I get the download files? + +Go to [https://www.device42.com/update/](https://www.device42.com/update/), there are now two options for download - the latest Main Appliance (MA) or the latest Remote Collector (RC). Enter your email in the field shown and we will send the file to you, along with release notes and next steps. + +## Can I download the newest RC despite my MA version? + +No, it’s required that you be on the immediately-prior Main Appliance release to get the latest RC update. For example, if the latest MA version was 17.07.00, you cannot download the RC release of 17.07.02 until you’re on 17.07.00. + +## What happens if I attempt to download the RC before I install the newest MA? + +The download will stop and tell you that you must first upgrade the MA. + +## What if I install an older RC update onto a newer MA version? + +This action will fail - the installer will prompt you to get the correct version. + +## Will MA updates update my RCs? + +Yes, just as in the past, when you download the MA update, it will subsequently update your RCs to the latest version. + +## What if I’m on a much older version of the MA? + +If you’re more than three or four versions behind our current Main Appliance release (the website will give the specific cut off point), you will need to contact support for upgrade assistance. + +If you’re less than three versions behind, downloading the new MA file will bring you fully up to date. + +## If I am on the latest MA release, how do I update my Remote Collectors? + +This update will need to be pushed via the Appliance Manager once you have the upgrade file. Step by step instructions can be found here: [https://docs.device42.com/getstarted/faqs/](getstarted/faqs/index.md). diff --git a/docs/getstarted/installation/index.md b/docs/getstarted/installation/index.md index 25267fe2..a9cb4c11 100644 --- a/docs/getstarted/installation/index.md +++ b/docs/getstarted/installation/index.md @@ -1 +1,8 @@ -# Installation +--- +title: "Installation" +--- + +IMPORTANT NOTICE: Device42 is delivered as a virtual appliance. Root access to the appliance is not supported, and the VM will cease to function if you attempt to break into the root account. + +In this section, we will discuss the following Installation topics: + diff --git a/docs/getstarted/installation/sizing-recommendations.md b/docs/getstarted/installation/sizing-recommendations.md new file mode 100644 index 00000000..0b0972cd --- /dev/null +++ b/docs/getstarted/installation/sizing-recommendations.md @@ -0,0 +1,5 @@ +--- +title: "Sizing Recommendations" +--- + +![](/assets/images/sizing.png) diff --git a/docs/getstarted/public-deployment-best-practices.md b/docs/getstarted/public-deployment-best-practices.md new file mode 100644 index 00000000..e427915d --- /dev/null +++ b/docs/getstarted/public-deployment-best-practices.md @@ -0,0 +1,139 @@ +--- +title: "Device42 Public-Facing Deployment Best Practices & Recommendations" +--- + +## Device42 Application Hardening + +When deploying Device42 in a production environment, it's important to conform to common application hardening best practices. Many of these best practices are industry standards for any production application. This document attempts to outline these best practices within the context of Device42. + +The following is a high-level description of those best practices as recommended by Device42. + +  + +### Change all passwords for any default credentials + +For the Main Appliance (MA) this means changing the following sets of credentials: + +1. **System Console User** + +\- Default Credential: device42 | adm!nd42 + +2. **Web GUI Admin User** + +\- Default Credential: admin | adm!nd42 + +\- Note: This account can also be disabled entirely (though you will need at least one superuser active on the appliance) + +3. **Appliance Manager** + +\- Default Credential: d42admin | default + +\*\*Do note that if you are deploying through the AWS or Azure marketplaces then the passwords above are not the default values used. Review the below documentation for more information:\*\* + +\- \[AMAZON WEB SERVICES – INSTALLATION\] ([getstarted/installation/installation-amazon-web-services/](getstarted/installation/installation-amazon-web-services/)) + +\- \[MICROSOFT AZURE – INSTALLATION\] ([getstarted/installation/installation-microsoft-azure/?msclkid=9eaae2a3b67511ecaa2e4170df3a1898](getstarted/installation/installation-microsoft-azure/?msclkid=9eaae2a3b67511ecaa2e4170df3a1898)) + +For the Remote Collector (RC) this means changing the System Console User (Default Credential: client | device42). + +There is no Device42 configured credential for the Windows Discovery Service (WDS). + +  + +### Practice good password hygiene + +\- Set a strong passphrase for the secrets vault + +\- Device42 has a built-in password/secret vault and all secrets are encrypted using AES-256 bit encryption. Encryption is based on a passphrase entered by the user. (One time setup and you would need to secure the passphrase in case you need to restore the backup). This passphrase should ideally be random and as long as possible. + +\- Use burnt secrets whenever possible + +\- A “burnt secret” is simply a way to store a password and designate it as ‘un-retrievable’. If a password is set to ‘burnt’, it can never be retrieved after being stored, however, Device42 can utilize a “burnt secret” for discovery. + +\- If passwords must be stored in a viewable manner, limit access whenever possible + +\- Consider creating custom groups to limit users who can view secrets. + +\- Passwords can also have individual permissions to further restrict who can view/edit/use them + +\- Review the below documentation for more information: + +\- \[PASSWORD SECURITY AND PERMISSIONS\] ([passwords/password-security-and-permissions/](administration/passwords/password-security-and-permissions.md)) + +\- \[SET DEFAULT PASSWORD MANAGEMENT GROUP\] ([passwords/set-default-password-management-group/](administration/passwords/set-default-password-management-group.md)) + +\- Leverage \[password policies\] ([passwords/password-policy/](administration/passwords/password-policy.md)) to ensure that Device42 users have: + +\- Cryptographically strong passwords (i.e., min counts of numeric, special, and uppercase letter characters) + +\- Password expiration dates + +\- Max # of invalid login attempts + +  + +### Restrict access using groups with functional and object permissions + +\- Device42 includes role-based access control capabilities to restrict the actions and objects that users or groups can interact with + +\- Whenever possible it is recommended to take the least privileged approach + +\- For example, this might mean when creating dedicated users for API access, limit their actions to read-only if that is all that is required + +\- Users can also have staff access revoked meaning they can only interact with the API and can't login via the GUI + +\- Limiting the # of super users active on the appliance is also recommended whenever feasible + +  + +### Obfuscate access to the appliance + +Like any internal production application, Device42 should only be deployed in private networks and should never be allocated a public IP address directly. Device42 does not need to be open to the public internet in order to integrate with any of the SAAS based integrations that we maintain as the MA leverages our \[cloud connector\]  ([external-integrations/device42-cloud-connector-overview/](integration/external-integrations/device42-cloud-connector-overview.md)) to obfuscate your appliance from the public internet. If you are thinking of deploying Device42 with a dedicated public IP address it is highly recommended that you reach out to support@device42.com to discuss potential use cases that would merit such a configuration. If you must expose Device42 to the public internet, it is critical that you DO NOT have default credentials configured. Additionally, you should also take measures to restrict access to the management ports used by the appliance. This means restricting access to port 404 (Used for SSH access to the MA) and 4242/4343 (Used for http/https access to the appliance manager) + +To further obfuscate your MA, you may wish to also configure a proxy for any outbound HTTP/HTTPS connections. You can configure proxy settings from within the global settings section of the appliance manager. + +  + +### Additional security-related configurations + +\- Disable older TLS versions if not required + +\- By default, the appliance is configured to use TLS v.1.2 only but it is always good to double-check your current configuration. + +\- From the appliance manager you can see what TLS versions are enabled by navigating to Global Settings -> TLS versions for Web Console and TLS versions for Appliance Manager respectively. + +\- Disable HTTP access + +\- By default Device42 will upgrade HTTP connections to HTTPS however HTTP access can be disabled entirely + +\- From the appliance manager you can disable HTTP access by navigating to Global Settings -> Enable/Disable HTTP for Web Console and Appliance Manager SSL respectively. + +\- Import a HTTPS certificate + +\- You can add your own https certificate and key file to further secure the web console. + +\- See \[SET UP HTTPS CERT\] ([device42-appliance-manager/set-up-https-cert/](administration/appliance-manager/set-up-https-cert.md)) for more information. + +\- Set inactivity timeouts for user sessions + +\- Device42 provides global inactivity timeouts to kill stale sessions + +\- You can configure separate timeout values for general GUI access and access to the appliance manager + +\- Check your currently configured timeout values by navigating to Global Settings -> Set Inactivity logout time + +\- You can also configure a separate timeout value for the secrets vault. + +\- The secrets timeout is configured from the the web GUI under Tools -> Global Settings -> Secrets + +\- If you already leverage a SAML 2.0 provider like Okta or OneLogin that enforces 2FA or MFA, consider setting up a \[SAML 2.0 CONFIGURATION\] ([tools/saml-2-0-configuration/](administration/saml-2-0-configuration.md)) + +\- In addition to SAML, Device42 can also be configured to use Active Directory for authentication + +\- See \[ACTIVE DIRECTORY / LDAP USER SYNC\] ([auto-discovery/active-directory-sync.md](auto-discovery/active-directory-sync.md)) for more information + +\- Device42 also stores audit history events. Any login events or modifications to objects within the database are stored and retained for a configurable duration. + +\- Consider adjusting the 'Days to Keep logs:' setting from Tools -> Log Settings within the web GUI. + +\- You may also choose to offload these events to an external log collection tool like Splunk to keep them for historical purposes. See \[Splunk Integration with Device42\] ([https://www.device42.com/integrations/splunk/](https://www.device42.com/integrations/splunk/)) for more information on the Splunk integration. diff --git a/docs/getstarted/tutorials/index.md b/docs/getstarted/tutorials/index.md index 81c8590f..122bd05b 100644 --- a/docs/getstarted/tutorials/index.md +++ b/docs/getstarted/tutorials/index.md @@ -1 +1,6 @@ -# Tutorials +--- +title: "Tutorials" +--- + +Welcome to the Device42 tutorials section. Choose a topic below to get started! +  diff --git a/docs/infrastructure-management/accounting/index.md b/docs/infrastructure-management/accounting/index.md new file mode 100644 index 00000000..fcb82093 --- /dev/null +++ b/docs/infrastructure-management/accounting/index.md @@ -0,0 +1,6 @@ +--- +title: "Accounting" +--- + +Device42 provides support for tracking Contracts and Purchases. Contracts are used for tracking Support Contracts, Warranty Contracts, and multi-product Purchases. Purchase Line Items are used for tracking single product purchases. + diff --git a/docs/infrastructure-management/connectivity/creating-patch-panels-from-scratch-in-device42-an-example.md b/docs/infrastructure-management/connectivity/creating-patch-panels-from-scratch-in-device42-an-example.md new file mode 100644 index 00000000..7e98d6f8 --- /dev/null +++ b/docs/infrastructure-management/connectivity/creating-patch-panels-from-scratch-in-device42-an-example.md @@ -0,0 +1,112 @@ +--- +title: "Creating patch panels from scratch in Device42: an example" +--- + +In this chapter, we will take a step by step approach to create patch panels from scratch to end result. + +### The Goal + +The example is simpler in nature, but this will cover the basics of how to add patch panel connections in Device42. + +End goal is: + +1. Patch Panel A is connected to Patch panel B : Panel A Panel B. +2. Patch panel A is patched to switch-01. +3. Patch panel B is patched to devices in the same rack as Panel B. + +This will give us devices connectivity with switch ports. + +### Creating Patch Panel Models + +![](/assets/images/WEB-599_patch-panel-model-add.png) + +Before we add the patch panel, we need to create the template. In this example, this is a singular patch panel with 48 RJ-45 ports. Steps taken: + +- Go to _Resources > Assets > Patch Panel Models > Add Patch Panel Model_. +- Add a name, port type, the number of ports etc., for the model. +- _Save_ the patch panel model. + +### Creating Patch Panels + +![](/assets/images/WEB-599_patch-panels-1.png) + +![](/assets/images/WEB-599_patch-panels-2.png) + +![](/assets/images/WEB-599_patch-panels-3.png) + +1. Go to _Resources > All Assets > Add Asset_. +2. Give the name Panel A, choose the _Type_ Patch Panel, and choose the model created above. +3. Click _Save_. + +Repeat the same steps for Panel B, just change the name to Panel B in step 2. + +You can also specify the building, storage room, add tags and images of the front and back. + +### Adding the Back Connections or Termination + +![](/assets/images/WEB-599_patch-panels-4.png) + +1. Go to _Tools > Templates & Bulk Operations > Panel Back Connectivity_. +2. From the drop-down, choose _Patch Panel_ A, then select the beginning _port # from:_ 1_;_ next, select _port # to:_ 48, then select _Patch Panel_ B, _port # from:_ 1, and optionally, the _Cable Type_. +3. Click _Continue_. + +Now Panel A and Panel B are terminated to each other. + +![](/assets/images/WEB-599_patch-panels-5.png) + +### Patching Switch Ports to Panel A + +- Go to _Tools > Templates & Bulk Operations > Import/Export (xls)_. + +![](/assets/images/WEB-599_patch-panel-ports-import-file-download-menu.png) + +- Scroll down to _Patch Panel Ports_. + +![](/assets/images/WEB-599_patch-panel-ports-import-file-download.png) + +![wpid3707-patch_panel_switchport_excel.png](/assets/images/wpid3707-patch_panel_switchport_excel.png) + +In this example, ports from switch-01 are patched to Panel A. (You can create switch ports in bulk using switch templates as discussed under [Switch Templates](infrastructure-management/ipam/switch-templates.md)). + +The tedious way to do this will be to add each switch port to each panel port. But we are not going to do that. The recommended way to do the same is to use the API Excel import option. Steps: + +1. Download the sample excel file from _Create/update Patch Panel Ports_ in that page. +2. Our columns will look like this: **number    patch\_panel\_id    switch    switchport** +3. Add the rows for panel port number, panel ID (available from Asset list view/from APIs/or get using hover over in the status bar), switch name, and switch port name. +4. Import the XLS sheet. + +![wpid3705-patch_panel_id.png](/assets/images/wpid3705-patch_panel_id.png)![wpid3701-PanelA_Switch_Connection.png](/assets/images/wpid3701-PanelA_Switch_Connection.png) + +Upon import, you can see the switch ports connections on Panel A. + +### Patching Devices to Panel B + +![wpid3704-patch_panel_device_excel.png](/assets/images/wpid3704-patch_panel_device_excel.png) + +In this step, we will use the same sample excel sheet downloaded in step above. + +Column layout will be a little different and will look like this: **number    patch\_panel\_id    device    obj\_label1** + +Once we add the values to Excel and import it, the panel B will show following. + +![wpid3702-PanelB_device_Connection.png](/assets/images/wpid3702-PanelB_device_Connection.png) + +### Patch Panel Layout + +![wpid3709-patch_panel_visual_layout.png](/assets/images/wpid3709-patch_panel_visual_layout.png) + +Now if you go to Patch panel layout for Panel B and hover over any port or device, you will see the full visual path for that port. + +### Switch Port Level Connectivity + +![wpid3710-switch_port_view.png](/assets/images/wpid3710-switch_port_view.png) + +You will see the patch panel connectivity from each switch port view as well. + +### Device Level Connectivity + +![wpid3700-device_connectivity_patch_panel.png](/assets/images/wpid3700-device_connectivity_patch_panel.png) + +Similarly, in the Device view/edit page, you will see the patch panel connection under the tab "other". + +This concludes our chapter on how to create a patch panel layout in Device42. diff --git a/docs/infrastructure-management/connectivity/index.md b/docs/infrastructure-management/connectivity/index.md new file mode 100644 index 00000000..9d13edc3 --- /dev/null +++ b/docs/infrastructure-management/connectivity/index.md @@ -0,0 +1,9 @@ +--- +title: "Patch Panels" +created: 2013-03-06 +authors: + - d42docadmin +--- + +You can manage structured cabling. In this section, would discuss following topics: + diff --git a/docs/infrastructure-management/connectivity/patch-panel-cable-management-definitions-and-legends.md b/docs/infrastructure-management/connectivity/patch-panel-cable-management-definitions-and-legends.md new file mode 100644 index 00000000..8d183259 --- /dev/null +++ b/docs/infrastructure-management/connectivity/patch-panel-cable-management-definitions-and-legends.md @@ -0,0 +1,44 @@ +--- +title: "Patch panel cable management definitions and legends" +--- + +In this section, we will cover some of basic definitions we use for components related to patch panels in Device42. + +### Patch Panel Model + +![Patch Panel Model](/assets/images/patch_panel_model1.png) + +In Device42, a patch panel model works as a template for the creation of actual patch panels with various ports and properties. You create a template that contains fields for the type of panel, the number of ports, the types of ports, and some other information. Then, when you create an actual patch panel, you select a model as the basis for the patch panel. + +Each patch panel model can be either: + +- Singular +- or, Modular + +A Singular model is used for creating patch panels that have a single type of port. For example, if all ports are type RJ45 Ethernet, you can choose type Singular. + +![](/assets/images/patch_panel_model_singular1.png) + +A Modular patch panel model is used for creating patch panels with different types of ports. If you add a patch panel model as type modular, you will need to add at least one patch panel module model as defined below. + +### Patch Panel Module Model + +![Patch Panel Module Model](/assets/images/patch_panel_module_template1.png) + +If a patch panel model is type "modular", you must add at least one patch panel module. You will need one module for each type of port. Patch panel modules are based on a **Patch panel module model**. In other words, Patch panel module model is a template for patch panel modules. + +For each module template, you define the name, port type, # of ports etc. + +### Patch panel back connectivity + +![Patch panel back connectivity](/assets/images/patch_panel_back1.png) + +Patch panel back connectivity defines the "cable connection" for the patch panel. This can also be referred as termination or punch down of the patch panel connection. + +Here are a few example scenarios: + +1. A patch panel is wired to another patch panel with one-to-one terminated ports. +2. A patch is wired to multiple patch panels. +3. Wall jacks terminate in a patch panel. + +With the option to add individual back connections or bulk back connections, you can easily represent these scenarios in device42. (Photo by https://www.flickr.com/photos/njh/ under creative commons) diff --git a/docs/infrastructure-management/devices/archiving-devices-and-resources.md b/docs/infrastructure-management/devices/archiving-devices-and-resources.md new file mode 100644 index 00000000..f2345b52 --- /dev/null +++ b/docs/infrastructure-management/devices/archiving-devices-and-resources.md @@ -0,0 +1,98 @@ +--- +title: "Archiving Devices and Resources" +--- + +## Overview + +You can archive devices and other resources to retire them or to take them out of service but still keep a record of the archived object. Device42 displays a list view of archived objects, and you can view and edit individual archived objects. The instructions below show how to archive a device and archive a resource. + +## Archive a Device + +- Go to _Resources > Compute > All Devices_ to display the device list page. +- Click the name of the device you want archive to display its view page, then click the ellipse menu and then _Archive_. + +![](/assets/images/D42-22895_Archive-1-viewbutton-1-1-250x107.png) + +  + +- Device42 displays a archive device prompt page. Click _Yes, I’m sure_ to archive the device. Click your browser’s Back button to return to the device view page. + +![](/assets/images/D42-22895_Archive-1-device-archive-prompt-page-250x148.png) + +  + +- Device42 adds the device to the Archived Objects list page. + +### Bulk Device Archive Option + +You can archive multiple devices simultaneously using the _Fast Background Archive_ command in the Actions menu on the Devices list page rather than having to archive the devices individually. Select the devices you want to archive, and then select the command. Note that this command does not display a confirmation prompt. + +![](/assets/images/18.05.00_device-list-fast-background-archive-action.PNG.jpg) + +## Archive a Resource + +- Go to _Resources > Resources > All Resources_ to display the Resources list page. +- Click the name of the resource you want to archive to display the resource view page. + +![](/assets/images/D42-22895_Archive-1-resource-archive-button-250x107.png) + +  + +- Click _Archive_ at the top right of the view page. +- Device42 displays an Archive Object pop-up with information about the resource. Click _Show_ to see additional information; you can also add optional notes. + +![](/assets/images/D42-22895_Archive-2-resource-show-250x105.png) + +![](/assets/images/D42-22895_Archive-3-resource-expanded-250x105.png) + +  + +  + +- Click _Archive_ to archive the resource. +- Device42 adds the resource to the Archived Objects list page. + +## View and Edit Archived Objects + +- Go to _Analytics > Audit Logs > Archived Objects_ to display the list page. + +![](/assets/images/D42-22895_Archive-6-archive-object-menu-2-250x108.png) + +![](/assets/images/D42-22895_Archive-2-archive-list-1-250x71.png) + +  + +  + +- You can sort the objects list by _Object Type_ or by _Archive Date_. + +![](/assets/images/D42-22895_Archive-2-archive-list-1-250x71.png) + +  + +- Click on the name of an archived object to view it. + +![](/assets/images/D42-22895_Archive-3-archive-object-view-1-1-250x112.png) + +  + +  + +- Information about the archived object’s child elements appears on the right of the page. Hover over the links next to the child elements to display pop-ups with additional information about the element. + +![](/assets/images/D42-22895_Archive-5-view-object-popups-250x114.png) + +  + +- Click _Edit_ at the top right to add or edit notes about the archived object. (Note that all the other information on the page is read-only.) Click _Save_ when done. + +![](/assets/images/D42-22895_Archive-4-archive-object-edit-1-1-250x105.png) + +  + +## Delete an Archived Object + +- On the Archived Objects list page, click the check box next to the object you want to delete. +- Select either _Delete with Detailed Confirmation_ or _Fast Background Delete_ from the Actions menu, and then click the blue hammer icon. + +![](/assets/images/D42-22895_Archive-7-archive-object-delete-1-1-250x78.png) diff --git a/docs/infrastructure-management/devices/index.md b/docs/infrastructure-management/devices/index.md new file mode 100644 index 00000000..a9e3e3fb --- /dev/null +++ b/docs/infrastructure-management/devices/index.md @@ -0,0 +1,6 @@ +--- +title: "Devices" +--- + +In this section, we will discuss various device properties and types and some tips for working with devices. + diff --git a/docs/infrastructure-management/ipam/index.md b/docs/infrastructure-management/ipam/index.md new file mode 100644 index 00000000..9d3194e6 --- /dev/null +++ b/docs/infrastructure-management/ipam/index.md @@ -0,0 +1,21 @@ +--- +title: "IPAM" +--- + +**IP Address Management _\[aka IPAM\]_** software helps IT systems admins track and manage the IP addresses in their computer networks. + +[IP Address Management (IPAM)](https://www.device42.com/features/ip-address-management/) is an essential part of Device42. With Device42's comprehensive network autodiscovery, it's never been easier to maintain up-to-date documentation of your IP Addresses, MAC Addresses, and DNS Infrastructure. In this section, we will cover VLAN, Subnet, IP Address, MAC Address, Switch Port Connectivity, and IP NATs. + +## Discovering IP Addresses + +There are multiple ways Device42 can discover IP Addresses and related information: + +- [Network SNMP Discovery](auto-discovery/network-auto-discovery.md): Configuring and running SNMP autodiscovery to gather subnets, IP to MAC Address relationships, and MAC Address to Switch Port relationship information. +- [Device42's Auto Discovery](auto-discovery/windows-and-hyper-v-auto-discovery.md): Using the autodiscovery client to discover Microsoft Windows and Linux and/or UNIX devices on your network, including their IP and MAC Address details. +- [Device42's Ping Sweep Tool](auto-discovery/d42-ping-sweep.md): This page details usage of the ping sweep utility to keep your IP Address information up-to-date. + +## Importing IP addresses into Device42 + +Importing existing IP addresses from [Microsoft Excel & CSV spreadsheets](getstarted/importing-data-from-existing-spreadsheets.md) is easy - Take advantage of this powerful feature to import existing IP Address data from MS Excel and/or .CSV _\[Comma Separated Value\]_ spreadsheets into Device42 IPAM. + +  diff --git a/docs/infrastructure-management/mobile-inventory/index.md b/docs/infrastructure-management/mobile-inventory/index.md new file mode 100644 index 00000000..3178cf4e --- /dev/null +++ b/docs/infrastructure-management/mobile-inventory/index.md @@ -0,0 +1,6 @@ +--- +title: "Mobile Inventory" +--- + +Starting with v311 you can now auto-assign customized asset #s to devices or non-IP based assets and also print customized QR codes for easier inventory management. We will cover following topics in this chapter: + diff --git a/docs/infrastructure-management/parts-and-parts-slots/index.md b/docs/infrastructure-management/parts-and-parts-slots/index.md index 8f37f9c3..17baad84 100644 --- a/docs/infrastructure-management/parts-and-parts-slots/index.md +++ b/docs/infrastructure-management/parts-and-parts-slots/index.md @@ -1 +1,9 @@ -# Parts and parts slots +--- +title: "Parts and Parts Slots" +--- + +Parts management was complete re-vamped in v15.04+. With many powerful new features, parts now play a larger role in Device42: Parts can now be inserted into parts slots, and parts themselves may also have ports. See the below documentation for more information! + +To learn about **Parts Slots**, see https://docs.device42.com/devices/device-parts-slots/ for a page dedicated to that topic. + + diff --git a/docs/infrastructure-management/power-and-environmental-monitoring/environmental-monitoring.md b/docs/infrastructure-management/power-and-environmental-monitoring/environmental-monitoring.md index 8ddcddc5..468e3d37 100644 --- a/docs/infrastructure-management/power-and-environmental-monitoring/environmental-monitoring.md +++ b/docs/infrastructure-management/power-and-environmental-monitoring/environmental-monitoring.md @@ -15,4 +15,3 @@ When sensors are discovered, they are created along with an asset record in Devi * * * -**Related Topics:** \[pagelist child\_of="250"\] diff --git a/docs/infrastructure-management/power-and-environmental-monitoring/index.md b/docs/infrastructure-management/power-and-environmental-monitoring/index.md new file mode 100644 index 00000000..073a3c21 --- /dev/null +++ b/docs/infrastructure-management/power-and-environmental-monitoring/index.md @@ -0,0 +1,8 @@ +--- +title: "Power and Environmental Monitoring" +--- + +In this section, we will discuss Power and Environmental Monitoring and Control using Device42. + +Please note that these features require purchase of at least the Power Monitoring Module.  If you have not purchased this module, you will not see the features described in this section. + diff --git a/docs/infrastructure-management/power-units/index.md b/docs/infrastructure-management/power-units/index.md new file mode 100644 index 00000000..da6c2caf --- /dev/null +++ b/docs/infrastructure-management/power-units/index.md @@ -0,0 +1,6 @@ +--- +title: "PDUs" +--- + +You can define PDU, PDU ports and do basic rack display for the PDUs. In this section, we will discuss following topics: + diff --git a/docs/infrastructure-management/software/index.md b/docs/infrastructure-management/software/index.md new file mode 100644 index 00000000..5568949c --- /dev/null +++ b/docs/infrastructure-management/software/index.md @@ -0,0 +1,13 @@ +--- +title: "Software" +--- + +## Software + +Select _Resources > Software Components_ to select the following items: All Software Components, Software License Models, Software in Use, or EOL / EOS. + +![](/assets/images/Software_menu.png) + +When you create a discovery job, remember to select the _Discover Software_ option to discover software information. + +![](/assets/images/WEB-293_SoftwareServices-Discover-Options.png) diff --git a/docs/integration/api-overview/index.md b/docs/integration/api-overview/index.md new file mode 100644 index 00000000..1e8ff99f --- /dev/null +++ b/docs/integration/api-overview/index.md @@ -0,0 +1,15 @@ +--- +title: "API Overview" +--- + +_ + +Device42 features comprehensive RESTful API's, which are the primary method of entering, editing, and retriving data - especially externally and/or programmatically! + +_ + +**\*\*Please note that the [Device42 APIs](https://api.device42.com/) feature their own comprehensive documentation site @ [https://api.device42.com/](https://api.device42.com/) !!\*\*** + +If you are looking for detailed API information, or would simply like more information about anything API-related then you're finding on docs.device42.com, simply visit the [Device42 API Documentation Site at api.device42.com](https://api.device42.com/)! + + diff --git a/docs/integration/external-integrations/index.md b/docs/integration/external-integrations/index.md new file mode 100644 index 00000000..cd3abd23 --- /dev/null +++ b/docs/integration/external-integrations/index.md @@ -0,0 +1,22 @@ +--- +title: "External Integrations and Migrations" +created: 2015-07-06 +authors: + - d42docadmin +--- + +## 3rd Party Software integrations index: + +_Click the title of the integration you're interested in below to jump directly to that integration's documentation page._ + +**Browse & download integrations at [https://www.device42.com/integrations/](https://www.device42.com/integrations/)** + +Device42's integrates with many popular 3rd party IT tools - Integrate Device42 with your favorite ITSM, CM, SIEM, or IPAM today! + +* * * + +### Tools for Custom Integrations + +Bulk Data Management Tools: [https://www.device42.com/bulk-data-management/](https://www.device42.com/bulk-data-management/) Device42 RESTful API Documentation: [https://api.device42.com/](https://api.device42.com/) + +Various other useful integrations, import, sample scripts, and open source tools we've written can be found on our GitHub site: [https://github.com/device42](https://github.com/device42). diff --git a/docs/integration/imports/index.md b/docs/integration/imports/index.md new file mode 100644 index 00000000..31bad4c0 --- /dev/null +++ b/docs/integration/imports/index.md @@ -0,0 +1,5 @@ +--- +title: "Imports" +--- + +Sections covering importing data in Excel spreadsheets. Topics: diff --git a/docs/reports/dbb-cookbook/in b/docs/reports/dbb-cookbook/in new file mode 100644 index 00000000..e69de29b diff --git a/docs/reports/dbb-cookbook/index.md b/docs/reports/dbb-cookbook/index.md new file mode 100644 index 00000000..56ca9690 --- /dev/null +++ b/docs/reports/dbb-cookbook/index.md @@ -0,0 +1,13 @@ +--- +title: "DBB - Cookbook" +--- + +**Introduction** + +The Data Building Blocks Cookbook is a collection of insightful queries that provide report examples for common use cases. These "recipes" often feature the new DBBs. These queries can be used "as is" or modified to meet business reporting requirements. We will continue to expand the Cookbook as required and as new DBBs are added. + +[**Application Dependency Mapping Recipes**](dbb-cookbook/app-dependency-mapping/) + +[**Compute Recipes**](dbb-cookbook/compute/) + +[**Security Recipes**](dbb-cookbook/security/) diff --git a/docs/reports/enrichai-data.md b/docs/reports/enrichai-data.md new file mode 100644 index 00000000..0073ba54 --- /dev/null +++ b/docs/reports/enrichai-data.md @@ -0,0 +1,35 @@ +--- +title: "EnrichAI Data" +sidebar_position: 1 +--- + +EnrichAI Data is a Device42 service to enrich discovered data – currently Device42 supports enrichment of discovered device OS data and Vendor data – additional data types will be added in future releases. + +  + +When EnrichAI is enabled, customer data such as OS, vendor, and the related architecture information that is collected during discovery jobs is queued up and then sent in batches to the EnrichAI service via https. The EnrichAI service will respond back with the enriched data if a match is found and the enriched data is displayed on the EnrichAI Data page. All data sent to the EnrichAI service is completely anonymized and cannot be traced back. Additionally the data being sent will never contain any identifiable information such as hostnames, IP Addresses, MAC Addresses, etc. Below is a sample of the payload + +Payload: \[{"client\_id":"D42","client\_version":"999.99.99.9999999999","items": \[{"entity\_type":"os","parameters":{"os\_architecture":"","os\_name":"junos","os\_version":"12.3R12-S1","os\_version\_no":""},"req\_id":"os\_7"}, {"entity\_type":"vendor","parameters":{"vendor":"brocade"},"req\_id":"vendor\_3"}\]}\] + +Note: The Main Appliance will need to be able to reach the following domains for cloud services to be registered. + +- - [https://crs.device42.io/](https://crs.device42.io/) + - _[https://enrichai.device42.io/api/normalizations](https://enrichai.device42.io/api/normalizations)_ + +  + +Select _Analytics > EnrichAI Data_ to display the EnrichAI Data list page. + +![](/assets/images/18.04.00_EnrichAI_data-list-page.jpg) + +Click the _Enriched Value_ link to view the data record. If you want, you can lock an EnrichAI data record to prevent Device42 from updating it in the future. + +![](/assets/images/18.04.00_EnrichAI_data-view-page-os.jpg) + +Device42 also currently displays EnrichAI Data information on OS and vendor view pages that have been enriched. The image below shows a vendor view page with EnrichAI Data – click the link to go to the data view page. Enriched data information is also available via API and DOQL in the vendor and deviceOS DOQL views. + +![](/assets/images/18.04.00_EnrichAI_vendor-view-page.jpg) + +  + +\* Note: Device42 reserves the right to make changes/updates to the internal matching algorithm and or the golden records that are provided with this service diff --git a/docs/reports/enrichai-opt-out.md b/docs/reports/enrichai-opt-out.md new file mode 100644 index 00000000..5c4f5c37 --- /dev/null +++ b/docs/reports/enrichai-opt-out.md @@ -0,0 +1,33 @@ +--- +title: "EnrichAI Opt Out" +--- + +EnrichAI Data is a Device42 service to enrich discovered data – currently Device42 supports enrichment of discovered device OS data and Vendor data – additional data types will be added in future releases. This section details the steps to take if you choose to disable this enrichment service. Please note that if you re-discover data that was previously enriched, then you will lose that data until you opt back into the EnrichAI cloud service. + +  + +Select _Tools > Cloud Services_ to display the Cloud Services page. + +![](/assets/images/Optout1.png) + +You can see the status of your cloud services from this view. In this example EnrichAI is currently Enabled. + +![](/assets/images/Optout2.png) + +To disable this feature, you will click the _Edit_ button in the bottom right corner of the screen. + +![](/assets/images/Optout3.png) + +Once the _Edit_ button has been selected, you will see the option to disable the EnrichAI service highlighted below. + +![](/assets/images/Optout4.png) + +Select the action you would like which in this example is to _Disable._ + +![](/assets/images/Optout5.png) + +_EnrichAI_ will show as being _Disabled_. Select _Save_ in the bottom right to save your changes. + +![](/assets/images/Optout6-1.png) + +If you would like to opt back into the EnrichAI service, then you will follow the same steps to enable. Once re-enabled we recommend to re-run your discovery jobs to ensure that your data is enriched. diff --git a/docs/reports/reports/index.md b/docs/reports/reports/index.md new file mode 100644 index 00000000..2b09871c --- /dev/null +++ b/docs/reports/reports/index.md @@ -0,0 +1,6 @@ +--- +title: "Reports" +--- + +These sections cover entries found in the reporting menu of the Device42 appliance. Note that the much more capable Advanced Reporting Engine has superceded what is now referred to as "Legacy Reporting", and should be utilized for creation of any new reports going forward. + diff --git a/docusaurus.config.js b/docusaurus.config.js index aed0f461..590e88a7 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -158,11 +158,7 @@ const config = { }, { to: '/apps/application-components/application-component-templates/', - from: ['/software/application-components/', '/apps/application-components/'], - }, - { - to: '/apps/business-applications/building-business-applications-in-device42/', - from: ['/apps/business-applications/'], + from: ['/software/application-components/'], }, { to: '/administration/active-directory-and-openldap-support/', @@ -980,6 +976,10 @@ const config = { to: '/how-to-videos/update-device42-appliance-how-to/', from: ['/how-to-videos/update-d42-how-to/'], }, + { + to: '/reports/enrichai-data/', + from: ['/enrichai-data/'], + }, ], }, ], diff --git a/static/assets/sizing.png b/static/assets/sizing.png new file mode 100644 index 00000000..91307a56 Binary files /dev/null and b/static/assets/sizing.png differ