Clean injection of Availability section (#3206)

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
This commit is contained in:
Clinton Wolfe 2018-08-09 08:34:49 -04:00 committed by Jared Quick
parent ac596dc015
commit 2de06bdeb5
146 changed files with 1460 additions and 0 deletions

View file

@ -9,6 +9,16 @@ Use the `aide_conf` InSpec audit resource to test the rules established for the
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.37.6 of InSpec.
## Syntax
An `aide_conf` resource block can be used to determine if the selection lines contain one (or more) directories whose files should be added to the aide database:

View file

@ -11,6 +11,16 @@ Use the `apache` InSpec audit resource to test the state of the Apache server on
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.51.15 of InSpec.
## Syntax
An `apache` InSpec audit resource block declares settings that should be tested:

View file

@ -9,6 +9,16 @@ Use the `apache_conf` InSpec audit resource to test the configuration settings f
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `apache_conf` InSpec audit resource block declares configuration settings that should be tested:

View file

@ -9,6 +9,16 @@ Use the `apt` InSpec audit resource to verify Apt repositories on the Debian and
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `apt` resource block tests the contents of Apt and PPA repositories:

View file

@ -9,6 +9,16 @@ Use the `audit_policy` InSpec audit resource to test auditing policies on the Wi
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `audit_policy` resource block declares a parameter that belongs to an audit policy category or subcategory:

View file

@ -9,6 +9,16 @@ Use the `auditd` InSpec audit resource to test the rules for logging that exist
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.38.8 of InSpec.
## Syntax
An `auditd` resource block declares one (or more) rules to be tested, and then what that rule should do:

View file

@ -9,6 +9,16 @@ Use the `auditd_conf` InSpec audit resource to test the configuration settings f
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `auditd_conf` resource block declares configuration settings that should be tested:

View file

@ -13,6 +13,16 @@ Each AWS Cloudtrail Trail is uniquely identified by its `trail_name` or `trail_a
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_cloudtrail_trail` resource block identifies a trail by `trail_name`.

View file

@ -13,6 +13,16 @@ Each AWS CloudTrail Trails is uniquely identified by its trail name or trail arn
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_cloudtrail_trails` resource block collects a group of CloudTrail Trails and then tests that group.

View file

@ -11,6 +11,16 @@ Cloudwatch Alarms are currently identified using the metric name and metric name
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_cloudwatch_alarm` resource block searches for a Cloudwatch Alarm, specified by several search options. If more than one Alarm matches, an error occurs.

View file

@ -11,6 +11,16 @@ A Log Metric Filter (LMF) is an AWS resource that observes log traffic, looks fo
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_cloudwatch_log_metric_filter` resource block searches for an LMF, specified by several search options. If more than one log metric filter matches, an error occurs.

View file

@ -13,6 +13,16 @@ As of April 2018, each AWS region may have only one Delivery Channel.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.21 of InSpec.
## Resource Parameters
An `aws_config_delivery_channel` resource block declares the tests for a single AWS Config Delivery Channel.

View file

@ -12,6 +12,16 @@ As of April 2018, you are only permitted one configuration recorder per region.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.32 of InSpec.
## Resource Parameters
An `aws_config_recorder` resource block declares the tests for a single AWS configuration recorder.

View file

@ -9,6 +9,16 @@ Use the `aws_ec2_instance` InSpec audit resource to test properties of a single
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_ec2_instance` resource block declares the tests for a single AWS EC2 instance by either name or id.

View file

@ -13,6 +13,16 @@ Each EC2 instance is uniquely identified by its ID.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.72 of InSpec.
## Syntax
An `aws_ec2_instances` resource block collects a group of EC2 Instances and then tests that group.

View file

@ -11,6 +11,16 @@ To audit ELBs in bulk or to search, use `aws_elbs` (plural).
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.2.10 of InSpec.
## Resource Parameters
An `aws_elb` resource block declares the tests for a single AWS ELB by ELB name.

View file

@ -11,6 +11,16 @@ To audit a specific ELB in detail when its name is known, use `aws_elb` (singula
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.2.10 of InSpec.
## Syntax
An `aws_elb` resource block uses an optional filter to select a group of ELBs and then tests that group.

View file

@ -7,6 +7,16 @@ platform: aws
Use the `aws_flow_log` InSpec audit resource to test properties of a single Flow Log.
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.2.10 of InSpec.
## Syntax
describe aws_flow_log('fl-9c718cf5') do

View file

@ -9,6 +9,16 @@ Use the `aws_iam_access_key` InSpec audit resource to test properties of a singl
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_access_key` resource block declares the tests for a single AWS IAM access key. An access key is uniquely identified by its access key id.

View file

@ -14,6 +14,16 @@ Access Keys are closely related to AWS User resources. Use this resource to perf
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_access_keys` resource block uses an optional filter to select a group of access keys and then tests that group.

View file

@ -11,6 +11,16 @@ To test properties of multiple or all groups, use the `aws_iam_groups` resource.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_group` resource block identifies a group by group name.

View file

@ -11,6 +11,16 @@ To test properties of a single group, use the `aws_iam_group` resource.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_groups` resource block uses an optional filter to select a collection of IAM groups and then tests that collection.

View file

@ -9,6 +9,16 @@ Use the `aws_iam_password_policy` InSpec audit resource to test properties of th
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_password_policy` resource block takes no parameters. Several properties and matchers are available.

View file

@ -13,6 +13,16 @@ Each IAM Policy is uniquely identified by either its `policy_name` or `arn`.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_policies` resource block collects a group of IAM Policies and then tests that group.

View file

@ -13,6 +13,16 @@ Each IAM Policy is uniquely identified by either its policy\_name or arn.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_policy` resource block identifies a policy by policy name.

View file

@ -9,6 +9,16 @@ Use the `aws_iam_role` InSpec audit resource to test properties of a single IAM
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
# Ensure that a certain role exists by name

View file

@ -13,6 +13,16 @@ To test properties of a specific AWS user use the `aws_iam_user` resource.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_root_user` resource block requires no parameters but has several matchers.

View file

@ -13,6 +13,16 @@ To test properties of the special AWS root user (which owns the account), use th
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Resource Parameters
An `aws_iam_user` resource block declares a user by name, and then lists tests to be performed.

View file

@ -13,6 +13,16 @@ To test properties of the special AWS root user (which owns the account), use th
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_iam_users` resource block uses a filter to select a group of users and then tests that group. With no filter, it returns all AWS IAM users.

View file

@ -14,6 +14,16 @@ Each AWS KMS Key is uniquely identified by its key_id or arn.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.21 of InSpec.
## Syntax
An aws_kms_key resource block identifies a key by key_arn or the key id.

View file

@ -15,6 +15,16 @@ Each AWS KMS Key is uniquely identified by its key-id or key-arn.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_kms_keys` resource block uses an optional filter to select a group of KMS Keys and then tests that group.

View file

@ -10,6 +10,16 @@ RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Micros
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.21 of InSpec.
## Syntax
An `aws_rds_instance` resource block uses resource parameters to search for an RDS instance, and then tests that RDS instance. If no RDS instances match, no error is raised, but the `exists` matcher will return `false` and all properties will be `nil`. If more than one RDS instance matches (due to vague search parameters), an error is raised.

View file

@ -9,6 +9,16 @@ Use the `aws_route_table` InSpec audit resource to test properties of a single R
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
# Ensure that a certain route table exists by name

View file

@ -8,6 +8,16 @@ Use the `aws_route_tables` InSpec audit resource to test properties of all or a
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.30 of InSpec.
## Syntax
# Ensure that there is at least one route table

View file

@ -21,6 +21,16 @@ In particular, users of the `be_public` matcher should carefully examine the con
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_s3_bucket` resource block declares a bucket by name, and then lists tests to be performed.

View file

@ -17,6 +17,16 @@ S3 object security is a complex matter. For details on how AWS evaluates reques
As of January 2018, this resource supports evaluating S3 Object ACLs. In particular, users of the `be_public` matcher should carefully examine the conditions under which the matcher will detect an insecure bucket. See the `be_public` section under the Matchers section below.
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.10 of InSpec.
## Syntax
An `aws_s3_bucket_object` resource block declares a bucket and an object key by name, and then lists tests to be performed.

View file

@ -10,6 +10,16 @@ Use the `aws_s3_bucket` InSpec audit resource to perform in-depth auditing of a
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.30 of InSpec.
## Syntax
An `aws_s3_buckets` resource block takes no arguments

View file

@ -18,6 +18,16 @@ While this resource provides facilities for searching inbound and outbound rules
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
Resource parameters: group_id, group_name, id, vpc_id

View file

@ -11,6 +11,16 @@ Security groups are a networking construct that contain ingress and egress rules
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_security_groups` resource block uses an optional filter to select a group of security groups and then tests that group.

View file

@ -8,6 +8,16 @@ Use the `aws_sns_subscription` InSpec audit resource to test detailed properties
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.10 of InSpec.
## Syntax
An `aws_sns_subscription` resource block uses resource parameters to search for a SNS Subscription, and then tests that subscriptions properties. If no Subscriptions match, no error is raised, but the `exists` matcher will return `false` and all properties will be `nil`.

View file

@ -8,6 +8,16 @@ Use the `aws_sns_topic` InSpec audit resource to test properties of a single AWS
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
# Ensure that a topic exists and has at least one subscription

View file

@ -9,6 +9,16 @@ User the 'aws_sns_topic' InSpec audit resource to test a single SNS Topic in an
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.10 of InSpec.
## Syntax
An `aws_sns_topics` resource block takes no filter conditions.

View file

@ -13,6 +13,16 @@ To test properties of all or a group of VPC subnets, use the `aws_subnets` resou
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_subnet` resource block uses the parameter to select a VPC and a subnet in the VPC.

View file

@ -13,6 +13,16 @@ Separating IP addresses allows for protection if there is a failure in one avail
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_subnets` resource block uses an optional filter to select a group of subnets and then tests that group.

View file

@ -17,6 +17,16 @@ Every AWS account has at least one VPC, the "default" VPC, in every region.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_vpc` resource block identifies a VPC by id. If no VPC ID is provided, the default VPC is used.

View file

@ -15,6 +15,16 @@ Every AWS account has at least one VPC, the "default" VPC, in every region.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
An `aws_vpcs` resource block uses an optional filter to select a group of VPCs and then tests that group.

View file

@ -8,6 +8,16 @@ title: About the azure_generic_resource Resource
Use the `azure_generic_resource` InSpec audit resource to test any valid Azure Resource. This is very useful if you need to test something that we do not yet have a specific Inspec resource for.
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
describe azure_generic_resource(group_name: 'MyResourceGroup', name: 'MyResource') do

View file

@ -7,6 +7,16 @@ platform: azure
Use the `azure_resource_group_resource_counts` InSpec audit resource to check the number of Azure resources in a resource group.
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
The name of the resource group is specified as a parameter on the resource:

View file

@ -7,6 +7,16 @@ platform: azure
Use the `azure_virtual_machine` InSpec audit resource to ensure that a Virtual Machine has been provisioned correctly.
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
The name of the machine and the resource group are required as properties to the resource.

View file

@ -7,6 +7,16 @@ platform: azure
Use this resource to ensure that a specific data disk attached to a machine has been created properly.
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.0.16 of InSpec.
## Syntax
The name of the resource group and machine are required to use this resource.

View file

@ -9,6 +9,16 @@ Use the `bash` InSpec audit resource to test an arbitrary command that is run on
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `command` resource block declares a command to be run, one (or more) expected outputs, and the location to which that output is sent:

View file

@ -9,6 +9,16 @@ Use the `bond` InSpec audit resource to test a logical, bonded network interface
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `bond` resource block declares a bonded network interface, and then specifies the properties of that bonded network interface to be tested:

View file

@ -9,6 +9,16 @@ Use the `bridge` InSpec audit resource to test basic network bridge properties,
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `bridge` resource block declares the bridge to be tested and what interface it should be associated with:

View file

@ -9,6 +9,16 @@ Use the `bsd_service` InSpec audit resource to test a service using a Berkeley O
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `bsd_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

View file

@ -9,6 +9,16 @@ Use the `chocolatey_package` InSpec audit resource to test if the named [Chocola
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v2.1.30 of InSpec.
## Syntax
A `chocolatey_package` resource block declares the name of a Chocolatey package to be tested:

View file

@ -9,6 +9,16 @@ Use the `command` InSpec audit resource to test an arbitrary command that is run
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `command` resource block declares a command to be run, one (or more) expected values, and the location to which that output is sent:

View file

@ -9,6 +9,16 @@ Use the `cpan` InSpec audit resource to test Perl modules that are installed by
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.43.5 of InSpec.
## Syntax
A `cpan` resource block declares a package and (optionally) a package version:

View file

@ -9,6 +9,16 @@ Use the `cran` InSpec audit resource to test R modules that are installed from C
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.43.5 of InSpec.
## Syntax
A `cran` resource block declares a package and (optionally) a package version:

View file

@ -9,6 +9,16 @@ Use the `crontab` InSpec audit resource to test the crontab entries for a partic
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.15.0 of InSpec.
## Syntax
A `crontab` resource block declares a user (which defaults to the current user, if not specified), and then the details to be tested, such as the schedule elements for each crontab entry or the commands itself:

View file

@ -9,6 +9,16 @@ Use the `csv` InSpec audit resource to test configuration data in a CSV file.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `csv` resource block declares the configuration data to be tested:

View file

@ -9,6 +9,16 @@ Use the `dh_params` InSpec audit resource to test Diffie-Hellman (DH) parameters
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.19.0 of InSpec.
## Syntax
A `dh_params` resource block declares a parameter file to be tested.

View file

@ -9,6 +9,16 @@ Use the `directory` InSpec audit resource to test if the file type is a director
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `directory` resource block declares the location of the directory to be tested, and then one (or more) matchers.

View file

@ -9,6 +9,16 @@ Use the `docker` InSpec audit resource to test configuration data for the Docker
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.21.0 of InSpec.
## Syntax
A `docker` resource block declares allows you to write test for many containers:

View file

@ -9,6 +9,16 @@ Use the `docker_container` InSpec audit resource to test a Docker container.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.21.0 of InSpec.
## Syntax
A `docker_container` resource block declares the configuration data to be tested:

View file

@ -9,6 +9,16 @@ Use the `docker_image` InSpec audit resource to verify a Docker image.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.21.0 of InSpec.
## Syntax
A `docker_image` resource block declares the image:

View file

@ -9,6 +9,16 @@ Use the `docker_service` InSpec audit resource to verify a docker swarm service.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.51.0 of InSpec.
## Syntax
A `docker_service` resource block declares the service by name:

View file

@ -12,6 +12,16 @@ a variety of settings and statuses.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.43.5 of InSpec.
## Syntax
describe elasticsearch do

View file

@ -9,6 +9,16 @@ Use the `etc_fstab` InSpec audit resource to test information about all partitio
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.37.6 of InSpec.
## Syntax
An etc_fstab rule specifies a device name, its mount point, its mount type, the options its mounted with,

View file

@ -9,6 +9,16 @@ Use the `etc_group` InSpec audit resource to test groups that are defined on Lin
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `etc_group` resource block declares a collection of properties to be tested:

View file

@ -9,6 +9,16 @@ Use the `etc_hosts` InSpec audit resource to test rules set to match IP addresse
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.37.6 of InSpec.
## Syntax
An etc/hosts rule specifies an IP address and what its hostname is along with optional aliases it can have.

View file

@ -9,6 +9,16 @@ Use the `etc_hosts_allow` InSpec audit resource to test rules defined for accept
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.39.1 of InSpec.
## Syntax
An etc/hosts.allow rule specifies one or more daemons mapped to one or more clients, with zero or more options to for accepting traffic when found.

View file

@ -9,6 +9,16 @@ Use the `etc_hosts_deny` InSpec audit resource to test rules for rejecting daemo
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.39.1 of InSpec.
## Syntax
An etc/hosts.deny rule specifies one or more daemons mapped to one or more clients, with zero or more options for rejecting traffic when found.

View file

@ -9,6 +9,16 @@ Use the `file` InSpec audit resource to test all system file types, including fi
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `file` resource block declares the location of the file type to be tested, the expected file type (if required), and one (or more) resource properties.

View file

@ -9,6 +9,16 @@ Use the `filesystem` InSpec resource to audit filesystem disk space usage.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.51.0 of InSpec.
## Syntax
A `filesystem` resource block declares tests for disk space in a partition:

View file

@ -11,6 +11,16 @@ A firewalld has a number of zones that can be configured to allow and deny acces
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.40.0 of InSpec.
## Syntax
describe firewalld do

View file

@ -9,6 +9,16 @@ Use the `gem` InSpec audit resource to test if a global Gem package is installed
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `gem` resource block declares a package and (optionally) a package version:

View file

@ -9,6 +9,16 @@ Use the `group` InSpec audit resource to test groups on the system.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `group` resource block declares a group, and then the details to be tested, such as if the group is a local group, the group identifier, or if the group exists:

View file

@ -9,6 +9,16 @@ Grub is a boot loader on the Linux platform used to load and then transfer contr
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `grub_conf` resource block declares a list of settings in a `grub.conf` file:

View file

@ -9,6 +9,16 @@ Use the `host` InSpec audit resource to test the name used to refer to a specifi
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `host` resource block declares a host name, and then (depending on what is to be tested) a port and/or a protocol:

View file

@ -9,6 +9,16 @@ Use the `http` InSpec audit resource to test an http endpoint.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.10.0 of InSpec.
## Syntax
An `http` resource block declares the configuration settings to be tested:

View file

@ -9,6 +9,16 @@ Use the `iis_app` InSpec audit resource to test the state of IIS on Windows Serv
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.28.0 of InSpec.
## Syntax
An `iis_app` resource block declares details about the named site:

View file

@ -9,6 +9,16 @@ Use the `iis_site` InSpec audit resource to test the state of IIS on Windows Ser
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `iis_site` resource block declares details about the named site:

View file

@ -9,6 +9,16 @@ Use the `inetd_conf` InSpec audit resource to test if a service is listed in the
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `inetd_conf` resource block declares the list of services that are enabled in the `inetd.conf` file:

View file

@ -9,6 +9,16 @@ Use the `ini` InSpec audit resource to test settings in an INI file.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `ini` resource block declares the configuration settings to be tested:

View file

@ -12,6 +12,16 @@ Use the `interface` InSpec audit resource to test basic network adapter properti
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `interface` resource block declares network interface properties to be tested:

View file

@ -9,6 +9,16 @@ Use the `iptables` InSpec audit resource to test rules that are defined in `ipta
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `iptables` resource block declares tests for rules in IP tables:

View file

@ -9,6 +9,16 @@ Use the `json` InSpec audit resource to test data in a JSON file.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `json` resource block declares the data to be tested. Assume the following JSON file:

View file

@ -15,6 +15,16 @@ method.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `kernel_module` resource block declares a module name, and then tests if that

View file

@ -9,6 +9,16 @@ Use the `kernel_parameter` InSpec audit resource to test kernel parameters on Li
These parameters are located under `/proc/cmdline`.
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `kernel_parameter` resource block declares a parameter and then a value to be tested:

View file

@ -11,6 +11,16 @@ This resource is mainly useful when used in conjunction with the x509_certificat
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.18.0 of InSpec.
## Syntax
An `key_rsa` resource block declares a `key file` to be tested.

View file

@ -9,6 +9,16 @@ Use the ``launchd_service`` InSpec audit resource to test a service using Launch
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A ``launchd_service`` resource block declares the name of a service and then one (or more) matchers to test the state of the service:

View file

@ -20,6 +20,16 @@ Entries in the `limits.conf` file are similar to:
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `limits_conf` resource block declares a domain to be tested, along with associated type, item, and value:

View file

@ -9,6 +9,16 @@ Use the `login_defs` InSpec audit resource to test configuration settings in the
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `login_defs` resource block declares the `login.defs` configuration data to be tested:

View file

@ -9,6 +9,16 @@ Use the `mount` InSpec audit resource to test the mount points on FreeBSD and Li
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
An `mount` resource block declares the synchronization settings that should be tested:

View file

@ -9,6 +9,16 @@ Use the `mssql_session` InSpec audit resource to test SQL commands run against a
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.24.0 of InSpec.
## Syntax
A `mssql_session` resource block declares the username and password to use for the session, and then the command to be run:

View file

@ -9,6 +9,16 @@ Use the `mysql_conf` InSpec audit resource to test the contents of the configura
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `mysql_conf` resource block declares one (or more) settings in the `my.cnf` file, and then compares the setting in the configuration file to the value stated in the test:

View file

@ -9,6 +9,16 @@ Use the `mysql_session` InSpec audit resource to test SQL commands run against a
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:

View file

@ -11,6 +11,16 @@ Nginx resource extracts and exposes data reported by the command 'nginx -V'
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.37.6 of InSpec.
## Syntax
An `nginx` InSpec audit resource block extracts configuration settings that should be tested:

View file

@ -11,6 +11,16 @@ Use the `nginx_conf` InSpec resource to test configuration data for the NGINX se
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.37.6 of InSpec.
## Syntax
An `nginx_conf` resource block declares the client NGINX configuration data to be tested:

View file

@ -9,6 +9,16 @@ Use the `npm` InSpec audit resource to test if a global NPM package is installed
<br>
## Availability
### Installation
This resource is distributed along with InSpec itself. You can use it automatically.
### Version
This resource first became available in v1.0.0 of InSpec.
## Syntax
A `npm` resource block declares a package and (optionally) a package version:

Some files were not shown because too many files have changed in this diff Show more