|
1 |
| -[comment]: # "Auto-generated SOAR connector documentation" |
2 | 1 | # BigFix
|
3 | 2 |
|
4 |
| -Publisher: Splunk |
5 |
| -Connector Version: 2.0.12 |
6 |
| -Product Vendor: IBM |
7 |
| -Product Name: BigFix |
8 |
| -Product Version Supported (regex): ".\*" |
9 |
| -Minimum Product Version: 6.3.0 |
| 3 | +Publisher: Splunk \ |
| 4 | +Connector Version: 2.0.13 \ |
| 5 | +Product Vendor: IBM \ |
| 6 | +Product Name: BigFix \ |
| 7 | +Minimum Product Version: 6.3.0 |
10 | 8 |
|
11 | 9 | This app supports several investigative actions on IBM Big Fix
|
12 | 10 |
|
13 | 11 | ### Configuration variables
|
| 12 | + |
14 | 13 | This table lists the configuration variables required to operate BigFix. These variables are specified when configuring a BigFix asset in Splunk SOAR.
|
15 | 14 |
|
16 | 15 | VARIABLE | REQUIRED | TYPE | DESCRIPTION
|
17 | 16 | -------- | -------- | ---- | -----------
|
18 |
| -**url** | required | string | URL including port |
19 |
| -**verify_server_cert** | optional | boolean | Verify server certificate |
20 |
| -**username** | required | string | Username |
21 |
| -**password** | required | password | Password |
22 |
| - |
23 |
| -### Supported Actions |
24 |
| -[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied configuration |
25 |
| -[list device groups](#action-list-device-groups) - List all sites on the system |
26 |
| -[list patches](#action-list-patches) - List patches from a site |
27 |
| -[list endpoints](#action-list-endpoints) - List all endpoints connected to the system |
28 |
| -[deploy patch](#action-deploy-patch) - Deploy a patch |
29 |
| -[get host](#action-get-host) - Get Bigfix ID |
| 17 | +**url** | required | string | URL including port | |
| 18 | +**verify_server_cert** | optional | boolean | Verify server certificate | |
| 19 | +**username** | required | string | Username | |
| 20 | +**password** | required | password | Password | |
| 21 | + |
| 22 | +### Supported Actions |
| 23 | + |
| 24 | +[test connectivity](#action-test-connectivity) - Validate the asset configuration for connectivity using supplied configuration \ |
| 25 | +[list device groups](#action-list-device-groups) - List all sites on the system \ |
| 26 | +[list patches](#action-list-patches) - List patches from a site \ |
| 27 | +[list endpoints](#action-list-endpoints) - List all endpoints connected to the system \ |
| 28 | +[deploy patch](#action-deploy-patch) - Deploy a patch \ |
| 29 | +[get host](#action-get-host) - Get Bigfix ID |
30 | 30 |
|
31 | 31 | ## action: 'test connectivity'
|
| 32 | + |
32 | 33 | Validate the asset configuration for connectivity using supplied configuration
|
33 | 34 |
|
34 |
| -Type: **test** |
| 35 | +Type: **test** \ |
35 | 36 | Read only: **True**
|
36 | 37 |
|
37 | 38 | #### Action Parameters
|
| 39 | + |
38 | 40 | No parameters are required for this action
|
39 | 41 |
|
40 | 42 | #### Action Output
|
41 |
| -No Output |
| 43 | + |
| 44 | +No Output |
42 | 45 |
|
43 | 46 | ## action: 'list device groups'
|
| 47 | + |
44 | 48 | List all sites on the system
|
45 | 49 |
|
46 |
| -Type: **investigate** |
| 50 | +Type: **investigate** \ |
47 | 51 | Read only: **True**
|
48 | 52 |
|
49 | 53 | #### Action Parameters
|
| 54 | + |
50 | 55 | No parameters are required for this action
|
51 | 56 |
|
52 | 57 | #### Action Output
|
| 58 | + |
53 | 59 | DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
|
54 | 60 | --------- | ---- | -------- | --------------
|
55 |
| -action_result.status | string | | success failed |
56 |
| -action_result.data.\*.Sites.\*.Description | string | | Clients that you can do destructive testing with |
57 |
| -action_result.data.\*.Sites.\*.Domain | string | `domain` | BES |
58 |
| -action_result.data.\*.Sites.\*.GatherURL | string | `url` | http://demo.value.com/cgi-bin/bfgather/bessupport |
59 |
| -action_result.data.\*.Sites.\*.GlobalReadPermission | string | | true |
60 |
| -action_result.data.\*.Sites.\*.Name | string | `bigfix site` | BES Support |
61 |
| -action_result.data.\*.Sites.\*.Subscription.CustomGroup.@JoinByIntersection | string | | false |
62 |
| -action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.@Comparison | string | | Contains |
63 |
| -action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.@PropertyName | string | | Computer Name |
64 |
| -action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.Relevance | string | | exists (computer name) whose (it as string as lowercase contains "ibm-bfe-t" as lowercase) |
65 |
| -action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.SearchText | string | | ibm-bfe-t |
66 |
| -action_result.data.\*.Sites.\*.Subscription.Mode | string | | All |
67 |
| -action_result.data.\*.Sites.\*.Type | string | | ExternalSite |
68 |
| -action_result.summary.num_sites | numeric | | 6 11 |
69 |
| -action_result.message | string | | Num sites: 6 Num sites: 11 |
70 |
| -summary.total_objects | numeric | | 1 |
71 |
| -summary.total_objects_successful | numeric | | 1 |
| 61 | +action_result.status | string | | success failed | |
| 62 | +action_result.data.\*.Sites.\*.Description | string | | Clients that you can do destructive testing with | |
| 63 | +action_result.data.\*.Sites.\*.Domain | string | `domain` | BES | |
| 64 | +action_result.data.\*.Sites.\*.GatherURL | string | `url` | http://demo.value.com/cgi-bin/bfgather/bessupport | |
| 65 | +action_result.data.\*.Sites.\*.GlobalReadPermission | string | | true | |
| 66 | +action_result.data.\*.Sites.\*.Name | string | `bigfix site` | BES Support | |
| 67 | +action_result.data.\*.Sites.\*.Subscription.CustomGroup.@JoinByIntersection | string | | false | |
| 68 | +action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.@Comparison | string | | Contains | |
| 69 | +action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.@PropertyName | string | | Computer Name | |
| 70 | +action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.Relevance | string | | exists (computer name) whose (it as string as lowercase contains "ibm-bfe-t" as lowercase) | |
| 71 | +action_result.data.\*.Sites.\*.Subscription.CustomGroup.SearchComponentPropertyReference.SearchText | string | | ibm-bfe-t | |
| 72 | +action_result.data.\*.Sites.\*.Subscription.Mode | string | | All | |
| 73 | +action_result.data.\*.Sites.\*.Type | string | | ExternalSite | |
| 74 | +action_result.summary.num_sites | numeric | | 6 11 | |
| 75 | +action_result.message | string | | Num sites: 6 Num sites: 11 | |
| 76 | +summary.total_objects | numeric | | 1 | |
| 77 | +summary.total_objects_successful | numeric | | 1 | |
72 | 78 |
|
73 | 79 | ## action: 'list patches'
|
| 80 | + |
74 | 81 | List patches from a site
|
75 | 82 |
|
76 |
| -Type: **investigate** |
| 83 | +Type: **investigate** \ |
77 | 84 | Read only: **True**
|
78 | 85 |
|
79 | 86 | This action lists all fixlets on a given site.
|
80 | 87 |
|
81 | 88 | #### Action Parameters
|
| 89 | + |
82 | 90 | PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
|
83 | 91 | --------- | -------- | ----------- | ---- | --------
|
84 |
| -**site_name** | required | Site Name | string | `bigfix site` |
85 |
| -**site_type** | required | Site Type | string | |
| 92 | +**site_name** | required | Site Name | string | `bigfix site` | |
| 93 | +**site_type** | required | Site Type | string | | |
86 | 94 |
|
87 | 95 | #### Action Output
|
| 96 | + |
88 | 97 | DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
|
89 | 98 | --------- | ---- | -------- | --------------
|
90 |
| -action_result.status | string | | success failed |
91 |
| -action_result.parameter.site_name | string | `bigfix site` | BES Support |
92 |
| -action_result.parameter.site_type | string | | external |
93 |
| -action_result.data.\*.Fixlets.\*.ID | string | | 1 |
94 |
| -action_result.data.\*.Fixlets.\*.LastModified | string | | Tue, 29 Aug 2017 15:45:59 +0000 |
95 |
| -action_result.data.\*.Fixlets.\*.Name | string | | BES Clients in Seat Count Grace Mode |
96 |
| -action_result.data.\*.Fixlets.\*.Resource | string | `url` | https://10.16.0.136:52311/api/fixlet/external/BES%20Support/1 |
97 |
| -action_result.summary.num_fixlets | numeric | | 910 |
98 |
| -action_result.message | string | | Num fixlets: 910 |
99 |
| -summary.total_objects | numeric | | 1 |
100 |
| -summary.total_objects_successful | numeric | | 1 |
| 99 | +action_result.status | string | | success failed | |
| 100 | +action_result.parameter.site_name | string | `bigfix site` | BES Support | |
| 101 | +action_result.parameter.site_type | string | | external | |
| 102 | +action_result.data.\*.Fixlets.\*.ID | string | | 1 | |
| 103 | +action_result.data.\*.Fixlets.\*.LastModified | string | | Tue, 29 Aug 2017 15:45:59 +0000 | |
| 104 | +action_result.data.\*.Fixlets.\*.Name | string | | BES Clients in Seat Count Grace Mode | |
| 105 | +action_result.data.\*.Fixlets.\*.Resource | string | `url` | https://10.16.0.136:52311/api/fixlet/external/BES%20Support/1 | |
| 106 | +action_result.summary.num_fixlets | numeric | | 910 | |
| 107 | +action_result.message | string | | Num fixlets: 910 | |
| 108 | +summary.total_objects | numeric | | 1 | |
| 109 | +summary.total_objects_successful | numeric | | 1 | |
101 | 110 |
|
102 | 111 | ## action: 'list endpoints'
|
| 112 | + |
103 | 113 | List all endpoints connected to the system
|
104 | 114 |
|
105 |
| -Type: **investigate** |
| 115 | +Type: **investigate** \ |
106 | 116 | Read only: **True**
|
107 | 117 |
|
108 | 118 | #### Action Parameters
|
| 119 | + |
109 | 120 | No parameters are required for this action
|
110 | 121 |
|
111 | 122 | #### Action Output
|
| 123 | + |
112 | 124 | DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
|
113 | 125 | --------- | ---- | -------- | --------------
|
114 |
| -action_result.status | string | | success failed |
115 |
| -action_result.data.\*.@Resource | string | `url` | https://10.16.0.136:52311/api/computer/3146683 |
116 |
| -action_result.data.\*.Active Directory Path | string | | <none> |
117 |
| -action_result.data.\*.Agent Type | string | | Native |
118 |
| -action_result.data.\*.Agent Version | string | `ip` | 9.5.6.63 |
119 |
| -action_result.data.\*.BES Relay Selection Method | string | | Automatic |
120 |
| -action_result.data.\*.BES Relay Service Installed | string | | BES Root Server |
121 |
| -action_result.data.\*.BES Root Server | string | | ibm-bfe-01.lab.phantominternal.net (0) |
122 |
| -action_result.data.\*.BIOS | string | | 09/21/15 |
123 |
| -action_result.data.\*.CPU | string | | 2200 MHz Xeon |
124 |
| -action_result.data.\*.Client Settings | string | | __Relay_Control_Server2= |
125 |
| -action_result.data.\*.Computer Name | string | `host name` | IBM-BFE-01 |
126 |
| -action_result.data.\*.Computer Type | string | | Virtual |
127 |
| -action_result.data.\*.DNS Name | string | `host name` | ibm-bfe-01.lab.phantominternal.net |
128 |
| -action_result.data.\*.Device Type | string | | Server |
129 |
| -action_result.data.\*.Distance to BES Relay | string | | 0 |
130 |
| -action_result.data.\*.Free Space on System Drive | string | | 30542 MB |
131 |
| -action_result.data.\*.ID | string | | 3146683 |
132 |
| -action_result.data.\*.IP Address | string | `ip` | 10.16.0.136 |
133 |
| -action_result.data.\*.Last Report Time | string | | Thu, 31 Aug 2017 23:41:01 +0000 |
134 |
| -action_result.data.\*.License Type | string | | Windows Server |
135 |
| -action_result.data.\*.Locked | string | | Yes |
136 |
| -action_result.data.\*.OS | string | | Win2012R2 6.3.9600 |
137 |
| -action_result.data.\*.RAM | string | | 4096 MB |
138 |
| -action_result.data.\*.Relay | string | | BES Root Server |
139 |
| -action_result.data.\*.Relay Name of Client | string | | ibm-bfe-01.lab.phantominternal.net |
140 |
| -action_result.data.\*.Setting.@Resource | string | | api/computer/3146683/ |
141 |
| -action_result.data.\*.Subnet Address | string | `ip` | 10.16.0.0 |
142 |
| -action_result.data.\*.Subscribed Sites | string | `url` | http://ibm-bfe-01.lab.phantominternal.net:52311/cgi-bin/bfgather.exe/mailboxsite3146683 |
143 |
| -action_result.data.\*.Total Size of System Drive | string | | 50847 MB |
144 |
| -action_result.data.\*.User Name | string | | Administrator |
145 |
| -action_result.summary.num_endpoints | numeric | | 1 |
146 |
| -action_result.message | string | | Num endpoints: 1 |
147 |
| -summary.total_objects | numeric | | 1 |
148 |
| -summary.total_objects_successful | numeric | | 1 |
| 126 | +action_result.status | string | | success failed | |
| 127 | +action_result.data.\*.@Resource | string | `url` | https://10.16.0.136:52311/api/computer/3146683 | |
| 128 | +action_result.data.\*.Active Directory Path | string | | <none> | |
| 129 | +action_result.data.\*.Agent Type | string | | Native | |
| 130 | +action_result.data.\*.Agent Version | string | `ip` | 9.5.6.63 | |
| 131 | +action_result.data.\*.BES Relay Selection Method | string | | Automatic | |
| 132 | +action_result.data.\*.BES Relay Service Installed | string | | BES Root Server | |
| 133 | +action_result.data.\*.BES Root Server | string | | ibm-bfe-01.lab.phantominternal.net (0) | |
| 134 | +action_result.data.\*.BIOS | string | | 09/21/15 | |
| 135 | +action_result.data.\*.CPU | string | | 2200 MHz Xeon | |
| 136 | +action_result.data.\*.Client Settings | string | | \_\_Relay_Control_Server2= | |
| 137 | +action_result.data.\*.Computer Name | string | `host name` | IBM-BFE-01 | |
| 138 | +action_result.data.\*.Computer Type | string | | Virtual | |
| 139 | +action_result.data.\*.DNS Name | string | `host name` | ibm-bfe-01.lab.phantominternal.net | |
| 140 | +action_result.data.\*.Device Type | string | | Server | |
| 141 | +action_result.data.\*.Distance to BES Relay | string | | 0 | |
| 142 | +action_result.data.\*.Free Space on System Drive | string | | 30542 MB | |
| 143 | +action_result.data.\*.ID | string | | 3146683 | |
| 144 | +action_result.data.\*.IP Address | string | `ip` | 10.16.0.136 | |
| 145 | +action_result.data.\*.Last Report Time | string | | Thu, 31 Aug 2017 23:41:01 +0000 | |
| 146 | +action_result.data.\*.License Type | string | | Windows Server | |
| 147 | +action_result.data.\*.Locked | string | | Yes | |
| 148 | +action_result.data.\*.OS | string | | Win2012R2 6.3.9600 | |
| 149 | +action_result.data.\*.RAM | string | | 4096 MB | |
| 150 | +action_result.data.\*.Relay | string | | BES Root Server | |
| 151 | +action_result.data.\*.Relay Name of Client | string | | ibm-bfe-01.lab.phantominternal.net | |
| 152 | +action_result.data.\*.Setting.@Resource | string | | api/computer/3146683/ | |
| 153 | +action_result.data.\*.Subnet Address | string | `ip` | 10.16.0.0 | |
| 154 | +action_result.data.\*.Subscribed Sites | string | `url` | http://ibm-bfe-01.lab.phantominternal.net:52311/cgi-bin/bfgather.exe/mailboxsite3146683 | |
| 155 | +action_result.data.\*.Total Size of System Drive | string | | 50847 MB | |
| 156 | +action_result.data.\*.User Name | string | | Administrator | |
| 157 | +action_result.summary.num_endpoints | numeric | | 1 | |
| 158 | +action_result.message | string | | Num endpoints: 1 | |
| 159 | +summary.total_objects | numeric | | 1 | |
| 160 | +summary.total_objects_successful | numeric | | 1 | |
149 | 161 |
|
150 | 162 | ## action: 'deploy patch'
|
| 163 | + |
151 | 164 | Deploy a patch
|
152 | 165 |
|
153 |
| -Type: **generic** |
| 166 | +Type: **generic** \ |
154 | 167 | Read only: **False**
|
155 | 168 |
|
156 | 169 | Create an action on BigFix that will run the given action from the given fixlet.<br><br>The <b>computer_ids</b> parameter takes a comma-separated list of BigFix computer IDs. If no computers are given, the action will be run on the default computers configured on BigFix. If the action should run on all computers set the <b>computer_ids</b> parameter to <b>all</b>.
|
157 | 170 |
|
158 | 171 | #### Action Parameters
|
| 172 | + |
159 | 173 | PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
|
160 | 174 | --------- | -------- | ----------- | ---- | --------
|
161 |
| -**fixlet_id** | required | Fixlet ID | numeric | `bigfix fixlet id` |
162 |
| -**action_id** | required | Action ID | string | |
163 |
| -**site_name** | required | Site Name | string | `bigfix site` |
164 |
| -**computer_ids** | optional | Target Computer IDs | string | `bigfix computer id` |
| 175 | +**fixlet_id** | required | Fixlet ID | numeric | `bigfix fixlet id` | |
| 176 | +**action_id** | required | Action ID | string | | |
| 177 | +**site_name** | required | Site Name | string | `bigfix site` | |
| 178 | +**computer_ids** | optional | Target Computer IDs | string | `bigfix computer id` | |
165 | 179 |
|
166 | 180 | #### Action Output
|
| 181 | + |
167 | 182 | DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
|
168 | 183 | --------- | ---- | -------- | --------------
|
169 |
| -action_result.status | string | | success failed |
170 |
| -action_result.parameter.action_id | string | | Action1 |
171 |
| -action_result.parameter.computer_ids | string | `bigfix computer id` | 12106585 |
172 |
| -action_result.parameter.fixlet_id | numeric | `bigfix fixlet id` | 56 |
173 |
| -action_result.parameter.site_name | string | `bigfix site` | Test Site 1 |
174 |
| -action_result.data.\*.Action.ID | string | | 65 |
175 |
| -action_result.data.\*.Action.LastModified | string | | Thu, 07 Sep 2017 22:55:38 +0000 |
176 |
| -action_result.data.\*.Action.Name | string | | Test Fixlet 1 |
177 |
| -action_result.data.\*.Action.Resource | string | `url` | https://10.16.0.136:52311/api/action/65 |
178 |
| -action_result.summary.spawned_action_id | string | | 65 |
179 |
| -action_result.message | string | | Action id: 65 |
180 |
| -summary.total_objects | numeric | | 1 |
181 |
| -summary.total_objects_successful | numeric | | 1 |
| 184 | +action_result.status | string | | success failed | |
| 185 | +action_result.parameter.action_id | string | | Action1 | |
| 186 | +action_result.parameter.computer_ids | string | `bigfix computer id` | 12106585 | |
| 187 | +action_result.parameter.fixlet_id | numeric | `bigfix fixlet id` | 56 | |
| 188 | +action_result.parameter.site_name | string | `bigfix site` | Test Site 1 | |
| 189 | +action_result.data.\*.Action.ID | string | | 65 | |
| 190 | +action_result.data.\*.Action.LastModified | string | | Thu, 07 Sep 2017 22:55:38 +0000 | |
| 191 | +action_result.data.\*.Action.Name | string | | Test Fixlet 1 | |
| 192 | +action_result.data.\*.Action.Resource | string | `url` | https://10.16.0.136:52311/api/action/65 | |
| 193 | +action_result.summary.spawned_action_id | string | | 65 | |
| 194 | +action_result.message | string | | Action id: 65 | |
| 195 | +summary.total_objects | numeric | | 1 | |
| 196 | +summary.total_objects_successful | numeric | | 1 | |
182 | 197 |
|
183 | 198 | ## action: 'get host'
|
| 199 | + |
184 | 200 | Get Bigfix ID
|
185 | 201 |
|
186 |
| -Type: **investigate** |
| 202 | +Type: **investigate** \ |
187 | 203 | Read only: **True**
|
188 | 204 |
|
189 | 205 | Get BigFix ID from Hostname.
|
190 | 206 |
|
191 | 207 | #### Action Parameters
|
| 208 | + |
192 | 209 | PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS
|
193 | 210 | --------- | -------- | ----------- | ---- | --------
|
194 |
| -**hostname** | required | Hostname | string | `host name` |
| 211 | +**hostname** | required | Hostname | string | `host name` | |
195 | 212 |
|
196 | 213 | #### Action Output
|
| 214 | + |
197 | 215 | DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES
|
198 | 216 | --------- | ---- | -------- | --------------
|
199 |
| -action_result.status | string | | success failed |
200 |
| -action_result.parameter.hostname | string | `host name` | ibm-bfe-t1 |
201 |
| -action_result.data.\*.Answer | string | | 12106585 |
202 |
| -action_result.summary | string | | |
203 |
| -action_result.message | string | | Successfully retrieved BigFix ID from Host Name |
204 |
| -summary.total_objects | numeric | | 1 |
205 |
| -summary.total_objects_successful | numeric | | 1 |
| 217 | +action_result.status | string | | success failed | |
| 218 | +action_result.parameter.hostname | string | `host name` | ibm-bfe-t1 | |
| 219 | +action_result.data.\*.Answer | string | | 12106585 | |
| 220 | +action_result.summary | string | | | |
| 221 | +action_result.message | string | | Successfully retrieved BigFix ID from Host Name | |
| 222 | +summary.total_objects | numeric | | 1 | |
| 223 | +summary.total_objects_successful | numeric | | 1 | |
| 224 | + |
| 225 | +______________________________________________________________________ |
| 226 | + |
| 227 | +Auto-generated Splunk SOAR Connector documentation. |
| 228 | + |
| 229 | +Copyright 2025 Splunk Inc. |
| 230 | + |
| 231 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 232 | +you may not use this file except in compliance with the License. |
| 233 | +You may obtain a copy of the License at |
| 234 | + |
| 235 | +http://www.apache.org/licenses/LICENSE-2.0 |
| 236 | + |
| 237 | +Unless required by applicable law or agreed to in writing, |
| 238 | +software distributed under the License is distributed on an "AS IS" BASIS, |
| 239 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 240 | +See the License for the specific language governing permissions and limitations under the License. |
0 commit comments