Skip to content

Commit

Permalink
Modified "Update Fixlet" README to better explain the XML structure
Browse files Browse the repository at this point in the history
Adding file link

Minor wording change

Added screenshots

Adding another screenshot

Adding link to fixlet.xml
  • Loading branch information
edgao committed Jun 4, 2015
1 parent 24a9d9c commit 46614c5
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions update-fixlet/cURL/README.md
@@ -1,3 +1,60 @@
Equivalent Action in Console
===
Right-click a Fixlet and select "Edit".
![Getting to the "Edit Fixlet" dialog](../img/edit-fixlet.png)

Explanation of [`fixlet.xml`](fixlet.xml)
===
* Title - (Permissible Values: any string) The name of the Fixlet
* Description - (Permissible Values: any string) A user-defined description of what the Fixlet does; can contain HTML content (if HTML is used, should be contained in a `<![CDATA[ ... ]]>` block.

![Image of fixlet description screen](../img/update-fixlet-description.png)
This screenshot shows the fixlet's title, description, and lists the descriptions of its actions.

* One or more *Relevance* tags, or a single *GroupRelevance* tag
* Relevance - (Permissible Values: any relevance expression that evaluates to true or false) A relevance statement that evaluates to true when executed against computers that this Fixlet should run on. All Relevance tags must evaluate to `true` in order for the Fixlet to run.
* GroupRelevance - Same as relevance but for Computer Groups that this Fixlet should run on.

![Image of fixlet relevance screen](../img/update-fixlet-relevance.png)
This screenshot shows where the contents of the `Relevance` tags go.

* Category - (Optional, defaults to `""`) (Permissible Values: any string) User-defined groupings (for example, "Licensing", "Update", "Computer Support")
* DownloadSize - (Optional, defaults to `0`) (Permissible Values: any non-negative integer) The size of the download that this Fixlet will run.
* Source - (Optional, defaults to `""`) (Permissible Values: any string) The organization or company that produced this Fixlet
* SourceID - (Optional, defaults to `""`) (Permissible Values: any string) The ID of that organization or company
* SourceReleaseDate - (Optional, defaults to `""`) (Permissible Values: any valid date in the format `yyyy-mm-dd`) The date this Fixlet was released
* SourceSeverity - (Optional, defaults to `""`) (Permissible Values: any string) How important this Fixlet is (Critical, Moderate, etc.)
* CVENames - (Optional, defaults to `""`) (Permissible Values: any string) The CVE (Common Vulnerabilities and Exposures) ID that this Fixlet addresses, if any
* SANSID - (Optional, defaults to `""`) (Permissible Values: any string) The SANS ID that this Fixlet addresses, if any.
* MimeField - (Optional)
* Name - (Permissible values: any string)
* Value - (Permissible values: any string)
* Domain - (Optional) (Permissible Values: Exactly 4 basic Latin characters)
* Delay - (Optional) (Permissible Values: strings matching the regular expression `P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]{1,6})?S)?)?`)

![Image of fixlet properties screen](../img/update-fixlet-properties.png)
This screenshot shows other properties that the fixlet can have.

* DefaultAction - (Optional; if omitted then no default action set) The Action to take by default (select the "This action is the default action" checkbox; bolded in the "Take Action" menu)
* _Attribute "ID"_ - (Permissible Values: any string) The name of this action. In the console, this is automatically be set to something like `Action1`.
* Description - (Optional, defaults to `""`) The text that appears in the Actions box of the Description tab of a Fixlet. Clicking on the link will initiate the "Take Action" dialog box
* PreLink - (Permissible Values: any string) The text that comes before the link
* Link - (Permissible Values: any string) The text that will be a link
* PostLink - (Permissible Values: any string) The text after the link
* ActionScript - (Permissible Values: any ActionScript)
* _Attribute "MIMEType"_ - (Optional, defaults to BigFix ActionScript)
* Action - (Optional, Repeatable; if omitted then no default action set) An Action that this Fixlet can take. Any number of these tags can appear; each will create a separate Action.
* _Attribute "ID"_ - (Permissible Values: any string) The name of this action. In the console, this is automatically be set to something like `Action1`.
* Description - (Optional, defaults to `""`) The text that appears in the Actions box of the Description tab of a Fixlet. Clicking on the link will initiate the "Take Action" dialog box
* PreLink - (Permissible Values: any string) The text that comes before the link
* Link - (Permissible Values: any string) The text that will be a link
* PostLink - (Permissible Values: any string) The text after the link
* ActionScript - (Permissible Values: any ActionScript)
* _Attribute "MIMEType"_ - (Optional, defaults to BigFix ActionScript)

![Image of fixlet actions screen](../img/update-fixlet-actions.png)
This screenshot shows the actions in this fixlet (there is only one, in this case). Notice that the `This action is the default action` button is checked; this is because the action was declared in a `DefaultAction` tag, rather than an `Action` tag. The `MIMEType` attribute of the `ActionScript` tag determines the script type.

Usage
---

Expand Down
Binary file added update-fixlet/img/edit-fixlet.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added update-fixlet/img/update-fixlet-actions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added update-fixlet/img/update-fixlet-description.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added update-fixlet/img/update-fixlet-properties.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added update-fixlet/img/update-fixlet-relevance.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 46614c5

Please sign in to comment.