Bots From Extension: vmware-nsx
Inventory Collection from VMWare NSX
This extension provides 36 bots.
Bot @nsx:alarms
Bot Position In Pipeline: Sink
Get alarms details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| timestamp | DateTime | Collects the data for a specified time period, supports CFXQL format. | |
| event_tag | Text | Specify tags for which alarms should be filtered, for example, INFRASTRUCTURE or INTELLIGENCE. | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| event_type | Text | Specify one or more event types for which alarms should be filtered. | |
| feature_name | Text | Specify one or more feature names for which alarms should be filtered. | |
| id | Text | Specify one or more alarm IDs for which alarms should be filtered. | |
| intent_path | Text | Specify one or more intent paths for which alarms should be filtered. | |
| node_id | Text | Specify one or more node IDs for which alarms should be filtered. | |
| node_resource_type | Text | Specify one or more node resource types for which alarms should be filtered. | |
| org | Text | Specify Org ID for which alarms should be filtered. | |
| page_size | Text | Maximum number of results to return in one page (server may return fewer). | |
| project | Text | Specify Project ID for which alarms should be filtered. | |
| severity | Text | Specify one or more severity levels for which alarms should be filtered. Must be one of CRITICAL, HIGH, MEDIUM, LOW. |
|
| sort_ascending | Text | If true, the value of the column are sorted in ascending order. Otherwise, in descending order. | |
| sort_by | Text | Sorting on column is based on the sort_by. sort_by represents the field in the output data on which sort is requested. |
|
| status | Text | Specify one or more status for which alarms should be filtered. Must be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED. |
|
| vpc | Text | Specify VPC ID for which alarms should be filtered. |
Bot @nsx:audit-logs
Bot Position In Pipeline: Sink
Get Audit Logs details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| log_age_limit | Text | 0 | Include logs with timstamps not past the age limit in days |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
| log_filter | Text | Audit logs should meet the filter condition. | |
| log_filter_type | Text | TEXT | Type of log filter. Expects TEXT or REGEX. |
| page_size | Text | Maximum number of results to return in this page (server may return fewer). |
Bot @nsx:container-application-instances
Bot Position In Pipeline: Sink
Get Container Application Instances details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:container-applications
Bot Position In Pipeline: Sink
Get Container Applications details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:container-cluster-nodes
Bot Position In Pipeline: Sink
Get Container Cluster nodes details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:container-clusters
Bot Position In Pipeline: Sink
Get Container Clusters details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:container-egresses
Bot Position In Pipeline: Sink
Get Container Egresses details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:container-gateways
Bot Position In Pipeline: Sink
Get Container Gateways details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:container-ingress-policies
Bot Position In Pipeline: Sink
Get Container Ingress Policies details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:domain-group-ips
Bot Position In Pipeline: Sink
Get Infra Domains Groups IP Addresses.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:domain-group-logical-switches
Bot Position In Pipeline: Sink
Get Infra Domains Groups Logical switches.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:domain-group-pods
Bot Position In Pipeline: Sink
Get Infra Domains Groups Pods.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:domain-group-ports
Bot Position In Pipeline: Sink
Get Infra Domains Groups Ports.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:domain-groups
Bot Position In Pipeline: Sink
Get Infra Domains Groups details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:domains
Bot Position In Pipeline: Sink
Get Infra Domains details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:events-config-list
Bot Position In Pipeline: Sink
Get events details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:infra-services
Bot Position In Pipeline: Sink
Get Infra Services details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:infra-sites
Bot Position In Pipeline: Sink
Get Infra sites details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:infra-tags
Bot Position In Pipeline: Sink
Get all Infra Tags details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:infra-tags-effective-resources
Bot Position In Pipeline: Sink
Get all Infra Tags' effective resources details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:ipsec-services
Bot Position In Pipeline: Sink
Get all VPN IPSec services.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:ipsec-sessions
Bot Position In Pipeline: Sink
Get all VPN IPSec Sessions.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:l7-access-profiles
Bot Position In Pipeline: Sink
Get Infra L7 Access Profiles details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:lldp-neighbors
Bot Position In Pipeline: Sink
Get LLDP Neighbor Properties of all Nodes.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:query-from-api
Bot Position In Pipeline: Sink
Get the output of the given API as a param (ex: fabric/virtual-machines). For more information on the available API URIs that support GET operation, please refer NSX API documentation.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| api* | Text | API to run for collecting data from (ex: nsx-fdmi/hba) | |
| base_uri | Text | api | Base API (ex: policy/api) |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:segment-ports
Bot Position In Pipeline: Sink
Get Segments ports details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:segments
Bot Position In Pipeline: Sink
Get Segments details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:system-excluded-vms
Bot Position In Pipeline: Sink
Get Infra System Excluded VMs details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:system-vms
Bot Position In Pipeline: Sink
Get Infra System VMs details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:tier0-instances
Bot Position In Pipeline: Sink
Get Tier-0 instances details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:tier1-instances
Bot Position In Pipeline: Sink
Get Tier-1 instances details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:tier1-interfaces
Bot Position In Pipeline: Sink
Get all interfaces under locale services under tier-1s.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:unassociated-vms
Bot Position In Pipeline: Sink
Get Infra Unassociated VM details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:virtual-interfaces
Bot Position In Pipeline: Sink
Get Virtual Interface details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:virtual-switches
Bot Position In Pipeline: Sink
Get Virtual Switches details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |
Bot @nsx:vms
Bot Position In Pipeline: Sink
Get VM details.
This bot expects a Restricted CFXQL.
Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot
| Parameter Name | Type | Default Value | Description |
|---|---|---|---|
| column_name* | Text | Column Name which contains ip addresses | |
| concurrent_discovery | Text | 10 | Number of concurrent jobs to run |