neulab/tldr huggingface dataset:
salt-call azurearm_network.network_interface_list_effective_network_security_groups test-iface0 testgroup
salt.modules.azurearm_network.network_interfaces_list(resource_group, **kwargs) New in version 2019.2.0.
List all network interfaces within a resource group.
Parameters resource_group -- The resource group name to list network interfaces within.
salt-call azurearm_network.network_interfaces_list testgroup
salt.modules.azurearm_network.network_interfaces_list_all(**kwargs) New in version 2019.2.0.
List all network interfaces within a subscription.
salt-call azurearm_network.network_interfaces_list_all
salt.modules.azurearm_network.network_security_group_create_or_update(name, resource_group, **kwargs) New in version 2019.2.0.
Create or update a network security group.
• name -- The name of the network security group to create.
salt-call azurearm_network.network_security_group_create_or_update testnsg testgroup
salt.modules.azurearm_network.network_security_group_delete(name, resource_group, **kwargs) New in version 2019.2.0.
Delete a network security group within a resource group.
• name -- The name of the network security group to delete.
salt-call azurearm_network.network_security_group_delete testnsg testgroup
salt.modules.azurearm_network.network_security_group_get(name, resource_group, **kwargs) New in version 2019.2.0.
Get details about a network security group within a resource group.
• name -- The name of the network security group to query.
salt-call azurearm_network.network_security_group_get testnsg testgroup
salt.modules.azurearm_network.network_security_groups_list(resource_group, **kwargs) New in version 2019.2.0.
List all network security groups within a resource group.
Parameters resource_group -- The resource group name to list network security         groups within.
salt-call azurearm_network.network_security_groups_list testgroup
salt.modules.azurearm_network.network_security_groups_list_all(**kwargs) New in version 2019.2.0.
List all network security groups within a subscription.
salt-call azurearm_network.network_security_groups_list_all
salt.modules.azurearm_network.public_ip_address_create_or_update(name, resource_group, **kwargs) New in version 2019.2.0.
Create or update a public IP address within a specified resource group.
• name -- The name of the public IP address to create.
• resource_group -- The resource group name assigned to the public IP address.
salt-call azurearm_network.public_ip_address_create_or_update test-ip-0 testgroup
salt.modules.azurearm_network.public_ip_address_delete(name, resource_group, **kwargs) New in version 2019.2.0.
Delete a public IP address.
• name -- The name of the public IP address to delete.
salt-call azurearm_network.public_ip_address_delete test-pub-ip testgroup
salt.modules.azurearm_network.public_ip_address_get(name, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific public IP address.
• name -- The name of the public IP address to query.
salt-call azurearm_network.public_ip_address_get test-pub-ip testgroup
salt.modules.azurearm_network.public_ip_addresses_list(resource_group, **kwargs) New in version 2019.2.0.
List all public IP addresses within a resource group.
Parameters resource_group -- The resource group name to list public IP addresses within.
salt-call azurearm_network.public_ip_addresses_list testgroup
salt.modules.azurearm_network.public_ip_addresses_list_all(**kwargs) New in version 2019.2.0.
List all public IP addresses within a subscription.
salt-call azurearm_network.public_ip_addresses_list_all
salt.modules.azurearm_network.route_create_or_update(name, address_prefix, next_hop_type, route_table, resource_group, next_hop_ip_address=None, **kwargs) New in version 2019.2.0.
Create or update a route within a specified route table.
• name -- The name of the route to create.
• address_prefix -- The destination CIDR to which the route applies.
• next_hop_type -- The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.
• next_hop_ip_address -- Optional IP address to which packets should be forwarded. Next hop values are only allowed in routes where the next_hop_type is 'VirtualAppliance'.
• route_table -- The name of the route table containing the route.
• resource_group -- The resource group name assigned to the route table.
salt-call azurearm_network.route_create_or_update test-rt '10.0.0.0/8' test-rt-table testgroup
salt.modules.azurearm_network.route_delete(name, route_table, resource_group, **kwargs) New in version 2019.2.0.
Delete a route from a route table.
• name -- The route to delete.
• route_table -- The route table containing the route.
salt-call azurearm_network.route_delete test-rt test-rt-table testgroup
salt.modules.azurearm_network.route_filter_create_or_update(name, resource_group, **kwargs) New in version 2019.2.0.
Create or update a route filter within a specified resource group.
• name -- The name of the route filter to create.
• resource_group -- The resource group name assigned to the route filter.
salt-call azurearm_network.route_filter_create_or_update test-filter testgroup
salt.modules.azurearm_network.route_filter_delete(name, resource_group, **kwargs) New in version 2019.2.0.
Delete a route filter.
• name -- The name of the route filter to delete.
salt-call azurearm_network.route_filter_delete test-filter testgroup
salt.modules.azurearm_network.route_filter_get(name, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific route filter.
• name -- The name of the route table to query.
salt-call azurearm_network.route_filter_get test-filter testgroup
salt.modules.azurearm_network.route_filter_rule_create_or_update(name, access, communities, route_filter, resource_group, **kwargs) New in version 2019.2.0.
Create or update a rule within a specified route filter.
• name -- The name of the rule to create.
• access -- The access type of the rule. Valid values are 'Allow' and 'Deny'.
• communities -- A list of BGP communities to filter on.
• route_filter -- The name of the route filter containing the rule.
salt-call azurearm_network.route_filter_rule_create_or_update                   test-rule allow "['12076:51006']" test-filter testgroup
salt.modules.azurearm_network.route_filter_rule_delete(name, route_filter, resource_group, **kwargs) New in version 2019.2.0.
Delete a route filter rule.
• name -- The route filter rule to delete.
• route_filter -- The route filter containing the rule.
salt-call azurearm_network.route_filter_rule_delete test-rule test-filter testgroup
salt.modules.azurearm_network.route_filter_rule_get(name, route_filter, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific route filter rule.
• name -- The route filter rule to query.
salt-call azurearm_network.route_filter_rule_get test-rule test-filter testgroup
salt.modules.azurearm_network.route_filter_rules_list(route_filter, resource_group, **kwargs) New in version 2019.2.0.
List all routes within a route filter.
• route_filter -- The route filter to query.
salt-call azurearm_network.route_filter_rules_list test-filter testgroup
salt.modules.azurearm_network.route_filters_list(resource_group, **kwargs) New in version 2019.2.0.
List all route filters within a resource group.
Parameters resource_group -- The resource group name to list route filters within.
salt-call azurearm_network.route_filters_list testgroup
salt.modules.azurearm_network.route_filters_list_all(**kwargs) New in version 2019.2.0.
List all route filters within a subscription.
salt-call azurearm_network.route_filters_list_all
salt.modules.azurearm_network.route_get(name, route_table, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific route.
• name -- The route to query.
salt-call azurearm_network.route_get test-rt test-rt-table testgroup
salt.modules.azurearm_network.route_table_create_or_update(name, resource_group, **kwargs) New in version 2019.2.0.
Create or update a route table within a specified resource group.
• name -- The name of the route table to create.
salt-call azurearm_network.route_table_create_or_update test-rt-table testgroup
salt.modules.azurearm_network.route_table_delete(name, resource_group, **kwargs) New in version 2019.2.0.
Delete a route table.
• name -- The name of the route table to delete.
salt-call azurearm_network.route_table_delete test-rt-table testgroup
salt.modules.azurearm_network.route_table_get(name, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific route table.
salt-call azurearm_network.route_table_get test-rt-table testgroup
salt.modules.azurearm_network.route_tables_list(resource_group, **kwargs) New in version 2019.2.0.
List all route tables within a resource group.
Parameters resource_group -- The resource group name to list route tables within.
salt-call azurearm_network.route_tables_list testgroup
salt.modules.azurearm_network.route_tables_list_all(**kwargs) New in version 2019.2.0.
List all route tables within a subscription.
salt-call azurearm_network.route_tables_list_all
salt.modules.azurearm_network.routes_list(route_table, resource_group, **kwargs) New in version 2019.2.0.
List all routes within a route table.
• route_table -- The route table to query.
salt-call azurearm_network.routes_list test-rt-table testgroup
salt.modules.azurearm_network.security_rule_create_or_update(name, access, direction, priority, protocol, security_group, resource_group, source_address_prefix=None, destination_address_prefix=None, source_port_range=None, destination_port_range=None, source_address_prefixes=None, destination_address_prefixes=None, source_port_ranges=None, destination_port_ranges=None, **kwargs) New in version 2019.2.0.
Create or update a security rule within a specified network security group.
• name -- The name of the security rule to create.
• access -- 'allow' or 'deny'
• direction -- 'inbound' or 'outbound'
• priority -- Integer between 100 and 4096 used for ordering rule application.
• protocol -- 'tcp', 'udp', or '*'
• destination_address_prefix -- The CIDR or destination IP range. Asterix '*' can also be used to match all destination IPs.  Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.  If this is an ingress rule, specifies where network traffic originates from.
• destination_port_range -- The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.
• source_address_prefix -- The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.  If this is an ingress rule, specifies where network traffic originates from.
• source_port_range -- The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.
• destination_address_prefixes -- A list of destination_address_prefix values. This parameter overrides destination_address_prefix and will cause any value entered there to be ignored.
• destination_port_ranges -- A list of destination_port_range values. This parameter overrides destination_port_range and will cause any value entered there to be ignored.
• source_address_prefixes -- A list of source_address_prefix values. This parameter overrides source_address_prefix and will cause any value entered there to be ignored.
• source_port_ranges -- A list of source_port_range values. This parameter overrides source_port_range and will cause any value entered there to be ignored.
salt-call azurearm_network.security_rule_create_or_update testrule1 allow outbound 101 tcp testnsg testgroup                   source_address_prefix='*' destination_address_prefix=internet source_port_range='*'                   destination_port_range='1-1024'
salt.modules.azurearm_network.security_rule_delete(security_rule, security_group, resource_group, **kwargs) New in version 2019.2.0.
Delete a security rule within a specified security group.
• name -- The name of the security rule to delete.
salt-call azurearm_network.security_rule_delete testrule1 testnsg testgroup
salt.modules.azurearm_network.security_rule_get(security_rule, security_group, resource_group, **kwargs) New in version 2019.2.0.
Get a security rule within a specified network security group.
salt-call azurearm_network.security_rule_get testrule1 testnsg testgroup
salt.modules.azurearm_network.security_rules_list(security_group, resource_group, **kwargs) New in version 2019.2.0.
List security rules within a network security group.
salt-call azurearm_network.security_rules_list testnsg testgroup
salt.modules.azurearm_network.subnet_create_or_update(name, address_prefix, virtual_network, resource_group, **kwargs) New in version 2019.2.0.
Create or update a subnet.
• name -- The name assigned to the subnet being created or updated.
• address_prefix -- A valid CIDR block within the virtual network.
• virtual_network -- The virtual network name containing the subnet.
salt-call azurearm_network.subnet_create_or_update testsubnet                   '10.0.0.0/24' testnet testgroup
salt.modules.azurearm_network.subnet_delete(name, virtual_network, resource_group, **kwargs) New in version 2019.2.0.
Delete a subnet.
• name -- The name of the subnet to delete.
salt-call azurearm_network.subnet_delete testsubnet testnet testgroup
salt.modules.azurearm_network.subnet_get(name, virtual_network, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific subnet.
• name -- The name of the subnet to query.
salt-call azurearm_network.subnet_get testsubnet testnet testgroup
salt.modules.azurearm_network.subnets_list(virtual_network, resource_group, **kwargs) New in version 2019.2.0.
List all subnets within a virtual network.
• virtual_network -- The virtual network name to list subnets within.
salt-call azurearm_network.subnets_list testnet testgroup
salt.modules.azurearm_network.usages_list(location, **kwargs) New in version 2019.2.0.
List subscription network usage for a location.
Parameters location -- The Azure location to query for network usage.
salt-call azurearm_network.usages_list westus
salt.modules.azurearm_network.virtual_network_create_or_update(name, address_prefixes, resource_group, **kwargs) New in version 2019.2.0.
Create or update a virtual network.
• name -- The name assigned to the virtual network being created or updated.
• address_prefixes -- A list of CIDR blocks which can be used by subnets within the virtual network.
salt-call azurearm_network.virtual_network_create_or_update                   testnet ['10.0.0.0/16'] testgroup
salt.modules.azurearm_network.virtual_network_delete(name, resource_group, **kwargs) New in version 2019.2.0.
Delete a virtual network.
• name -- The name of the virtual network to delete.
• resource_group -- The resource group name assigned to the virtual network
salt-call azurearm_network.virtual_network_delete testnet testgroup
salt.modules.azurearm_network.virtual_network_get(name, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific virtual network.
• name -- The name of the virtual network to query.
salt-call azurearm_network.virtual_network_get testnet testgroup
salt.modules.azurearm_network.virtual_networks_list(resource_group, **kwargs) New in version 2019.2.0.
List all virtual networks within a resource group.
Parameters resource_group -- The resource group name to list virtual networks within.
salt-call azurearm_network.virtual_networks_list testgroup
salt.modules.azurearm_network.virtual_networks_list_all(**kwargs) New in version 2019.2.0.
List all virtual networks within a subscription.
salt-call azurearm_network.virtual_networks_list_all
salt.modules.azurearm_resource Azure (ARM) Resource Execution Module
salt.modules.azurearm_resource.deployment_cancel(name, resource_group, **kwargs) New in version 2019.2.0.
Cancel a deployment if in 'Accepted' or 'Running' state.
• name -- The name of the deployment to cancel.
• resource_group -- The resource group name assigned to the deployment.
salt-call azurearm_resource.deployment_cancel testdeploy testgroup
salt.modules.azurearm_resource.deployment_check_existence(name, resource_group, **kwargs) New in version 2019.2.0.
Check the existence of a deployment.
• name -- The name of the deployment to query.
salt-call azurearm_resource.deployment_check_existence testdeploy testgroup
salt.modules.azurearm_resource.deployment_create_or_update(name, resource_group, deploy_mode='incremental', debug_setting='none', deploy_params=None, parameters_link=None, deploy_template=None, template_link=None, **kwargs) New in version 2019.2.0.
Deploys resources to a resource group.
• name -- The name of the deployment to create or update.
• deploy_mode -- The mode that is used to deploy resources. This value can be either 'incremental' or 'complete'. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.
• debug_setting -- The debug setting of the deployment. The permitted values are 'none', 'requestContent', 'responseContent', or 'requestContent,responseContent'. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.
• deploy_params -- JSON string containing name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parameters_link property or the deploy_params property, but not both.
• parameters_link -- The URI of a parameters file. You use this element to link to an existing parameters file. Use either the parameters_link property or the deploy_params property, but not both.
• deploy_template -- JSON string of template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. Use either the template_link property or the deploy_template property, but not both.
• template_link -- The URI of the template. Use either the template_link property or the deploy_template property, but not both.
salt-call azurearm_resource.deployment_create_or_update testdeploy testgroup
salt.modules.azurearm_resource.deployment_delete(name, resource_group, **kwargs) New in version 2019.2.0.
Delete a deployment.
• name -- The name of the deployment to delete.
salt-call azurearm_resource.deployment_delete testdeploy testgroup
salt.modules.azurearm_resource.deployment_export_template(name, resource_group, **kwargs) New in version 2019.2.0.
Exports the template used for the specified deployment.
salt-call azurearm_resource.deployment_export_template testdeploy testgroup
salt.modules.azurearm_resource.deployment_get(name, resource_group, **kwargs) New in version 2019.2.0.
Get details about a specific deployment.
salt-call azurearm_resource.deployment_get testdeploy testgroup
salt.modules.azurearm_resource.deployment_operation_get(operation, deployment, resource_group, **kwargs) New in version 2019.2.0.
Get a deployment operation within a deployment.
• operation -- The operation ID of the operation within the deployment.
• deployment -- The name of the deployment containing the operation.
salt-call azurearm_resource.deployment_operation_get XXXXX testdeploy testgroup
salt.modules.azurearm_resource.deployment_operations_list(name, resource_group, result_limit=10, **kwargs) New in version 2019.2.0.
List all deployment operations within a deployment.
• result_limit -- (Default: 10) The limit on the list of deployment operations.
salt-call azurearm_resource.deployment_operations_list testdeploy testgroup
salt.modules.azurearm_resource.deployment_validate(name, resource_group, deploy_mode=None, debug_setting=None, deploy_params=None, parameters_link=None, deploy_template=None, template_link=None, **kwargs) New in version 2019.2.0.
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager.
• name -- The name of the deployment to validate.
salt-call azurearm_resource.deployment_validate testdeploy testgroup
salt.modules.azurearm_resource.deployments_list(resource_group, **kwargs) New in version 2019.2.0.
List all deployments within a resource group.
salt-call azurearm_resource.deployments_list testgroup
salt.modules.azurearm_resource.policy_assignment_create(name, scope, definition_name, **kwargs) New in version 2019.2.0.
Create a policy assignment.
• name -- The name of the policy assignment to create.
• scope -- The scope of the policy assignment.
• definition_name -- The name of the policy definition to assign.
salt-call azurearm_resource.policy_assignment_create testassign         /subscriptions/bc75htn-a0fhsi-349b-56gh-4fghti-f84852 testpolicy
salt.modules.azurearm_resource.policy_assignment_delete(name, scope, **kwargs) New in version 2019.2.0.
Delete a policy assignment.
• name -- The name of the policy assignment to delete.
salt-call azurearm_resource.policy_assignment_delete testassign         /subscriptions/bc75htn-a0fhsi-349b-56gh-4fghti-f84852
salt.modules.azurearm_resource.policy_assignment_get(name, scope, **kwargs) New in version 2019.2.0.
Get details about a specific policy assignment.
• name -- The name of the policy assignment to query.
salt-call azurearm_resource.policy_assignment_get testassign         /subscriptions/bc75htn-a0fhsi-349b-56gh-4fghti-f84852
salt.modules.azurearm_resource.policy_assignments_list(**kwargs) New in version 2019.2.0.
List all policy assignments for a subscription.
salt-call azurearm_resource.policy_assignments_list
salt.modules.azurearm_resource.policy_assignments_list_for_resource_group(resource_group, **kwargs) New in version 2019.2.0.
List all policy assignments for a resource group.
Parameters resource_group -- The resource group name to list policy assignments within.
salt-call azurearm_resource.policy_assignments_list_for_resource_group testgroup
salt.modules.azurearm_resource.policy_definition_create_or_update(name, policy_rule, **kwargs) New in version 2019.2.0.
Create or update a policy definition.
• name -- The name of the policy definition to create or update.
• policy_rule -- A dictionary defining the policy rule.
salt-call azurearm_resource.policy_definition_create_or_update testpolicy '{...rule definition..}'
salt.modules.azurearm_resource.policy_definition_delete(name, **kwargs) New in version 2019.2.0.
Delete a policy definition.
Parameters name -- The name of the policy definition to delete.
salt-call azurearm_resource.policy_definition_delete testpolicy
salt.modules.azurearm_resource.policy_definition_get(name, **kwargs) New in version 2019.2.0.
Get details about a specific policy definition.
Parameters name -- The name of the policy definition to query.
salt-call azurearm_resource.policy_definition_get testpolicy
salt.modules.azurearm_resource.policy_definitions_list(hide_builtin=False, **kwargs) New in version 2019.2.0.
List all policy definitions for a subscription.
Parameters hide_builtin -- Boolean which will filter out BuiltIn policy definitions from the result.
salt-call azurearm_resource.policy_definitions_list
salt.modules.azurearm_resource.resource_group_check_existence(name, **kwargs) New in version 2019.2.0.
Check for the existence of a named resource group in the current subscription.
Parameters name -- The resource group name to check.
salt-call azurearm_resource.resource_group_check_existence testgroup
salt.modules.azurearm_resource.resource_group_create_or_update(name, location, **kwargs) New in version 2019.2.0.
Create or update a resource group in a given location.
• name -- The name of the resource group to create or update.
• location -- The location of the resource group. This value is not able to be updated once the resource group is created.
salt-call azurearm_resource.resource_group_create_or_update testgroup westus
salt.modules.azurearm_resource.resource_group_delete(name, **kwargs) New in version 2019.2.0.
Delete a resource group from the subscription.
Parameters name -- The resource group name to delete.
salt-call azurearm_resource.resource_group_delete testgroup
salt.modules.azurearm_resource.resource_group_get(name, **kwargs) New in version 2019.2.0.
Get a dictionary representing a resource group's properties.
Parameters name -- The resource group name to get.
salt-call azurearm_resource.resource_group_get testgroup
salt.modules.azurearm_resource.resource_groups_list(**kwargs) New in version 2019.2.0.
List all resource groups within a subscription.
salt-call azurearm_resource.resource_groups_list
salt.modules.azurearm_resource.subscription_get(subscription_id=None, **kwargs) New in version 2019.2.0.
Get details about a subscription.
Parameters subscription_id -- The ID of the subscription to query.
salt-call azurearm_resource.subscription_get XXXXXXXX
salt.modules.azurearm_resource.subscriptions_list(**kwargs) New in version 2019.2.0.
List all subscriptions for a tenant.
salt-call azurearm_resource.subscriptions_list
salt.modules.azurearm_resource.subscriptions_list_locations(subscription_id=None, **kwargs) New in version 2019.2.0.
List all locations for a subscription.
salt-call azurearm_resource.subscriptions_list_locations XXXXXXXX
salt.modules.azurearm_resource.tenants_list(**kwargs) New in version 2019.2.0.
List all tenants for your account.
salt-call azurearm_resource.tenants_list
salt.modules.bamboohr Support for BambooHR
Requires a subdomain and an apikey in /etc/salt/minion:
bamboohr: apikey: 012345678901234567890 subdomain: mycompany
salt.modules.bamboohr.list_employees(order_by='id') Show all employees for this company.
salt myminion bamboohr.list_employees
By default, the return data will be keyed by ID. However, it can be ordered by any other field. Keep in mind that if the field that is chosen contains duplicate values (i.e., location is used, for a company which only has one location), then each duplicate value will be overwritten by the previous.  Therefore, it is advisable to only sort by fields that are guaranteed to be unique.
salt myminion bamboohr.list_employees order_by=id salt myminion bamboohr.list_employees order_by=displayName salt myminion bamboohr.list_employees order_by=workEmail
salt.modules.bamboohr.list_meta_fields() Show all meta data fields for this company.
salt myminion bamboohr.list_meta_fields
salt.modules.bamboohr.list_users(order_by='id') Show all users for this company.
salt myminion bamboohr.list_users
salt myminion bamboohr.list_users order_by=id salt myminion bamboohr.list_users order_by=email
salt.modules.bamboohr.show_employee(emp_id, fields=None) Show all employees for this company.
salt myminion bamboohr.show_employee 1138
By default, the fields normally returned from bamboohr.list_employees are returned. These fields are:
• canUploadPhoto
• department
• displayName
• firstName
• id
• jobTitle
• lastName
• location
• mobilePhone
• nickname
• photoUploaded
• photoUrl
• workEmail
• workPhone
• workPhoneExtension
If needed, a different set of fields may be specified, separated by commas:
salt myminion bamboohr.show_employee 1138 displayName,dateOfBirth
A list of available fields can be found at http://www.bamboohr.com/api/documentation/employees.php
salt.modules.bamboohr.update_employee(emp_id, key=None, value=None, items=None) Update one or more items for this employee. Specifying an empty value will clear it for that employee.
salt myminion bamboohr.update_employee 1138 nickname Curly salt myminion bamboohr.update_employee 1138 nickname '' salt myminion bamboohr.update_employee 1138 items='{"nickname": "Curly"} salt myminion bamboohr.update_employee 1138 items='{"nickname": ""}
salt.modules.baredoc Baredoc walks the installed module and state directories and generates dictionaries and lists of the function names and their arguments.
New in version 3001.
salt.modules.baredoc.list_modules(name=False, names_only=False) Walk the Salt install tree for execution modules and return a dictionary or a list of their functions as well as their arguments.
• name -- specify a specific module to list. If not specified, all modules will be listed.
• names_only -- Return only a list of the callable functions instead of a dictionary with arguments
salt myminion baredoc.list_modules
myminion: ---------- [...] at: - atq: tag: null - atrm: args: args - at: args: args kwargs: kwargs - atc: jobid: null - jobcheck: kwargs: kwargs [...]
salt.modules.baredoc.list_states(name=False, names_only=False) Walk the Salt install tree for state modules and return a dictionary or a list of their functions as well as their arguments.
(example truncated for brevity)
salt myminion baredoc.list_states
myminion: ---------- [...] at: - present: name: null timespec: null tag: null user: null job: null unique_tag: false - absent: name: null jobid: null kwargs: kwargs - watch: name: null timespec: null tag: null user: null job: null unique_tag: false - mod_watch: name: null kwargs: kwargs [...]
salt.modules.baredoc.module_docs(*names) Return the docstrings for all modules. Optionally, specify a module or a function to narrow the selection.
Parameters name -- specify a specific module to list.
salt myminion baredoc.module_docs
salt.modules.baredoc.state_docs(*names) Return the docstrings for all state modules. Optionally, specify a state module or a function to narrow the selection.
salt myminion baredoc.state_docs at
salt.modules.bcache Module for managing BCache sets
BCache is a block-level caching mechanism similar to ZFS L2ARC/ZIL, dm-cache and fscache.  It works by formatting one block device as a cache set, then adding backend devices (which need to be formatted as such) to the set and activating them.
It's available in Linux mainline kernel since 3.10
https://www.kernel.org/doc/Documentation/bcache.txt
This module needs the bcache userspace tools to function.
salt.modules.bcache.attach_(dev=None) Attach a backing devices to a cache set If no dev is given, all backing devices will be attached.
salt '*' bcache.attach sdc salt '*' bcache.attach /dev/bcache1
Returns bool or None if nuttin' happened
salt.modules.bcache.back_make(dev, cache_mode='writeback', force=False, attach=True, bucket_size=None) Create a backing device for attachment to a set.  Because the block size must be the same, a cache set already needs to exist.
salt '*' bcache.back_make sdc cache_mode=writeback attach=True
• cache_mode -- writethrough, writeback, writearound or none.
• force -- Overwrite existing bcaches
• attach -- Immediately attach the backing device to the set
• bucket_size -- Size of a bucket (see kernel doc)
salt.modules.bcache.cache_make(dev, reserved=None, force=False, block_size=None, bucket_size=None, attach=True) Create BCache cache on a block device.  If blkdiscard is available the entire device will be properly cleared in advance.
salt '*' bcache.cache_make sdb reserved=10% block_size=4096
• reserved --
if dev is a full device, create a partition table with this size empty.
NOTE: this increases the amount of reserved space available to SSD garbage collectors, potentially (vastly) increasing performance
• block_size -- Block size of the cache; defaults to devices' logical block size
• force -- Overwrite existing BCache sets
• attach -- Attach all existing backend devices immediately
salt.modules.bcache.config_(dev=None, **kwargs) Show or update config of a bcache device.
If no device is given, operate on the cache set itself.
salt '*' bcache.config salt '*' bcache.config bcache1 salt '*' bcache.config errors=panic journal_delay_ms=150 salt '*' bcache.config bcache1 cache_mode=writeback writeback_percent=15
Returns config or True/False
salt.modules.bcache.detach(dev=None) Detach a backing device(s) from a cache set If no dev is given, all backing devices will be attached.
Detaching a backing device will flush its write cache.  This should leave the underlying device in a consistent state, but might take a while.
salt '*' bcache.detach sdc salt '*' bcache.detach bcache1
salt.modules.bcache.device(dev, stats=False, config=False, internals=False, superblock=False) Check the state of a single bcache device
salt '*' bcache.device bcache0 salt '*' bcache.device /dev/sdc stats=True
• stats -- include statistics
• settings -- include all settings
• internals -- include all internals
• superblock -- include superblock info
salt.modules.bcache.start() Trigger a start of the full bcache system through udev.
salt '*' bcache.start
salt.modules.bcache.status(stats=False, config=False, internals=False, superblock=False, alldevs=False) Show the full status of the BCache system and optionally all its involved devices
salt '*' bcache.status salt '*' bcache.status stats=True salt '*' bcache.status internals=True alldevs=True
• config -- include settings
• internals -- include internals
• superblock -- include superblock
salt.modules.bcache.stop(dev=None) Stop a bcache device If no device is given, all backing devices will be detached from the cache, which will subsequently be stopped.
WARNING: 'Stop' on an individual backing device means hard-stop; no attempt at flushing will be done and the bcache device will seemingly 'disappear' from the device lists
salt '*' bcache.stop
salt.modules.bcache.super_(dev) Read out BCache SuperBlock
salt '*' bcache.device bcache0 salt '*' bcache.device /dev/sdc
salt.modules.bcache.uuid(dev=None) Return the bcache UUID of a block device.  If no device is given, the Cache UUID is returned.
salt '*' bcache.uuid salt '*' bcache.uuid /dev/sda salt '*' bcache.uuid bcache0
salt.modules.beacons Module for managing the Salt beacons on a minion
salt.modules.beacons.add(name, beacon_data, **kwargs) Add a beacon on the minion
• name -- Name of the beacon to configure
• beacon_data -- Dictionary or list containing configuration for beacon.
Returns Boolean and status message on success or failure of add.
salt '*' beacons.add ps "[{'processes': {'salt-master': 'stopped', 'apache2': 'stopped'}}]"
salt.modules.beacons.delete(name, **kwargs) Delete a beacon item
Parameters name -- Name of the beacon to delete
Returns Boolean and status message on success or failure of delete.
salt '*' beacons.delete ps
salt '*' beacons.delete load
salt.modules.beacons.disable(**kwargs) Disable all beacons jobs on the minion
Returns Boolean and status message on success or failure of disable.
salt '*' beacons.disable
salt.modules.beacons.disable_beacon(name, **kwargs) Disable a beacon on the minion
Name   Name of the beacon to disable.
salt '*' beacons.disable_beacon ps
salt.modules.beacons.enable(**kwargs) Enable all beacons on the minion
Returns Boolean and status message on success or failure of enable.
salt '*' beacons.enable
salt.modules.beacons.enable_beacon(name, **kwargs) Enable beacon on the minion
Name   Name of the beacon to enable.
salt '*' beacons.enable_beacon ps
salt.modules.beacons.list_(return_yaml=True, include_pillar=True, include_opts=True, **kwargs) List the beacons currently configured on the minion
• return_yaml -- Whether to return YAML formatted output, default True
• include_pillar -- Whether to include beacons that are configured in pillar, default is True.
• include_opts -- Whether to include beacons that are configured in opts, default is True.
Returns List of currently configured Beacons.
salt '*' beacons.list
salt.modules.beacons.list_available(return_yaml=True, **kwargs) List the beacons currently available on the minion
Parameters return_yaml -- Whether to return YAML formatted output, default True
salt '*' beacons.list_available
salt.modules.beacons.modify(name, beacon_data, **kwargs) Modify an existing beacon
• beacon_data -- Dictionary or list containing updated configuration for beacon.
Returns Boolean and status message on success or failure of modify.
salt '*' beacons.modify ps "[{'salt-master': 'stopped'}, {'apache2': 'stopped'}]"
salt.modules.beacons.reset(**kwargs) Reset beacon configuration on the minion
salt '*' beacons.reset
salt.modules.beacons.save(**kwargs) Save all configured beacons to the minion config
Returns Boolean and status message on success or failure of save.
salt '*' beacons.save
salt.modules.bigip An execution module which can manipulate an f5 bigip via iControl REST
maturity develop
platform f5_bigip_11.6
salt.modules.bigip.add_pool_member(hostname, username, password, name, member) A function to connect to a bigip device and add a new member to an existing pool.
hostname The host/address of the bigip device
username The iControl REST username
password The iControl REST password
name   The name of the pool to modify
member The name of the member to add i.e. 10.1.1.2:80
salt '*' bigip.add_pool_members bigip admin admin my-pool 10.2.2.1:80
salt.modules.bigip.commit_transaction(hostname, username, password, label) A function to connect to a bigip device and commit an existing transaction.
label  the label of this transaction stored within the grain: bigip_f5_trans:<label>
salt '*' bigip.commit_transaction bigip admin admin my_transaction
salt.modules.bigip.create_monitor(hostname, username, password, monitor_type, name, **kwargs) A function to connect to a bigip device and create a monitor.
monitor_type The type of monitor to create
name   The name of the monitor to create
kwargs Consult F5 BIGIP user guide for specific options for each monitor type.  Typically, tmsh arg names are used.
salt '*' bigip.create_monitor bigip admin admin http my-http-monitor timeout=10 interval=5
salt.modules.bigip.create_node(hostname, username, password, name, address, trans_label=None) A function to connect to a bigip device and create a node.
name   The name of the node
address The address of the node
trans_label The label of the transaction stored within the grain: bigip_f5_trans:<label>
salt '*' bigip.create_node bigip admin admin 10.1.1.2
salt.modules.bigip.create_pool(hostname, username, password, name, members=None, allow_nat=None, allow_snat=None, description=None, gateway_failsafe_device=None, ignore_persisted_weight=None, ip_tos_to_client=None, ip_tos_to_server=None, link_qos_to_client=None, link_qos_to_server=None, load_balancing_mode=None, min_active_members=None, min_up_members=None, min_up_members_action=None, min_up_members_checking=None, monitor=None, profiles=None, queue_depth_limit=None, queue_on_connection_limit=None, queue_time_limit=None, reselect_tries=None, service_down_action=None, slow_ramp_time=None) A function to connect to a bigip device and create a pool.
name   The name of the pool to create.
members List of comma delimited pool members to add to the pool. i.e. 10.1.1.1:80,10.1.1.2:80,10.1.1.3:80
allow_nat [yes | no]
allow_snat [yes | no]
description [string]
gateway_failsafe_device [string]
ignore_persisted_weight [enabled | disabled]
ip_tos_to_client [pass-through | [integer]]
ip_tos_to_server [pass-through | [integer]]
link_qos_to_client [pass-through | [integer]]
link_qos_to_server [pass-through | [integer]]
load_balancing_mode [dynamic-ratio-member | dynamic-ratio-node | fastest-app-response | fastest-node | least-connections-members | least-connections-node | least-sessions | observed-member | observed-node | predictive-member | predictive-node | ratio-least-connections-member | ratio-least-connections-node | ratio-member | ratio-node | ratio-session | round-robin | weighted-least-connections-member | weighted-least-connections-node]
min_active_members [integer]
min_up_members [integer]
min_up_members_action [failover | reboot | restart-all]
min_up_members_checking [enabled | disabled]
monitor [name]
profiles [none | profile_name]
queue_depth_limit [integer]
queue_on_connection_limit [enabled | disabled]
queue_time_limit [integer]
reselect_tries [integer]
service_down_action [drop | none | reselect | reset]
slow_ramp_time [integer]
salt '*' bigip.create_pool bigip admin admin my-pool 10.1.1.1:80,10.1.1.2:80,10.1.1.3:80 monitor=http
salt.modules.bigip.create_profile(hostname, username, password, profile_type, name, **kwargs) A function to connect to a bigip device and create a profile.
profile_type The type of profile to create
name   The name of the profile to create
kwargs [ arg=val ] ... [arg=key1:val1,key2:val2] ...
Consult F5 BIGIP user guide for specific options for each monitor type.  Typically, tmsh arg names are used.
Creating Complex Args Profiles can get pretty complicated in terms of the amount of possible config options. Use the following shorthand to create complex arguments such as lists, dictionaries, and lists of dictionaries. An option is also provided to pass raw json as well.
lists [i,i,i]: param='item1,item2,item3'
Dictionary [k:v,k:v,k,v]: param='key-1:val-1,key-2:val2,key-3:va-3'
List of Dictionaries [k:v,k:v|k:v,k:v|k:v,k:v]: param='key-1:val-1,key-2:val-2|key-1:val-1,key-2:val-2|key-1:val-1,key-2:val-2'
JSON: 'j{ ... }j': cert-key-chain='j{ "default": { "cert": "default.crt", "chain": "default.crt", "key": "default.key" } }j'
Escaping Delimiters: Use \, or \: or \| to escape characters which shouldn't be treated as delimiters i.e. ciphers='DEFAULT\:!SSLv3'
salt '*' bigip.create_profile bigip admin admin http my-http-profile defaultsFrom='/Common/http' salt '*' bigip.create_profile bigip admin admin http my-http-profile defaultsFrom='/Common/http' \ enforcement=maxHeaderCount:3200,maxRequests:10
salt.modules.bigip.create_virtual(hostname, username, password, name, destination, pool=None, address_status=None, auto_lasthop=None, bwc_policy=None, cmp_enabled=None, connection_limit=None, dhcp_relay=None, description=None, fallback_persistence=None, flow_eviction_policy=None, gtm_score=None, ip_forward=None, ip_protocol=None, internal=None, twelve_forward=None, last_hop_pool=None, mask=None, mirror=None, nat64=None, persist=None, profiles=None, policies=None, rate_class=None, rate_limit=None, rate_limit_mode=None, rate_limit_dst=None, rate_limit_src=None, rules=None, related_rules=None, reject=None, source=None, source_address_translation=None, source_port=None, state=None, traffic_classes=None, translate_address=None, translate_port=None, vlans=None) A function to connect to a bigip device and create a virtual server.
name   The name of the virtual to create
destination [ [virtual_address_name:port] | [ipv4:port] | [ipv6.port] ]
pool   [ [pool_name] | none]
address_status [yes | no]
auto_lasthop [default | enabled | disabled ]
bwc_policy [none] | string]
cmp_enabled [yes | no]
dhcp_relay [yes | no]
connection_limit [integer]
state  [disabled | enabled]
fallback_persistence [none | [profile name] ]
flow_eviction_policy [none | [eviction policy name] ]
gtm_score [integer]
ip_forward [yes | no]
ip_protocol [any | protocol]
internal [yes | no]
twelve_forward (12-forward) [yes | no]
last_hop-pool [ [pool_name] | none]
mask   { [ipv4] | [ipv6] }
mirror { [disabled | enabled | none] }
nat64  [enabled | disabled]
persist [none | profile1,profile2,profile3 ... ]
profiles [none | default | profile1,profile2,profile3 ... ]
policies [none | default | policy1,policy2,policy3 ... ]
rate_class [name]
rate_limit [integer]
rate_limit_mode [destination | object | object-destination | object-source | object-source-destination | source | source-destination]
rate_limit_dst [integer]
rate_limitçsrc [integer]
rules  [none | [rule_one,rule_two ...] ]
related_rules [none | [rule_one,rule_two ...] ]
reject [yes | no]
source { [ipv4[/prefixlen]] | [ipv6[/prefixlen]] }
source_address_translation [none | snat:pool_name | lsn | automap ]
source_port [change | preserve | preserve-strict]
state  [enabled | disabled]
traffic_classes [none | default | class_one,class_two ... ]
translate_address [enabled | disabled]
translate_port [enabled | disabled]
vlans  [none | default | [enabled|disabled]:vlan1,vlan2,vlan3 ... ]
salt '*' bigip.create_virtual bigip admin admin my-virtual-3 26.2.2.5:80 \ pool=my-http-pool-http profiles=http,tcp
salt '*' bigip.create_virtual bigip admin admin my-virtual-3 43.2.2.5:80 \ pool=test-http-pool-http profiles=http,websecurity persist=cookie,hash \ policies=asm_auto_l7_policy__http-virtual \ rules=_sys_APM_ExchangeSupport_helper,_sys_https_redirect \ related_rules=_sys_APM_activesync,_sys_APM_ExchangeSupport_helper \ source_address_translation=snat:my-snat-pool \ translate_address=enabled translate_port=enabled \ traffic_classes=my-class,other-class \ vlans=enabled:external,internal
salt.modules.bigip.delete_monitor(hostname, username, password, monitor_type, name) A function to connect to a bigip device and delete an existing monitor.
monitor_type The type of monitor to delete
name   The name of the monitor to delete
salt '*' bigip.delete_monitor bigip admin admin http my-http-monitor
salt.modules.bigip.delete_node(hostname, username, password, name, trans_label=None) A function to connect to a bigip device and delete a specific node.
name   The name of the node which will be deleted.
salt '*' bigip.delete_node bigip admin admin my-node
salt.modules.bigip.delete_pool(hostname, username, password, name) A function to connect to a bigip device and delete a specific pool.
name   The name of the pool which will be deleted
salt '*' bigip.delete_node bigip admin admin my-pool
salt.modules.bigip.delete_pool_member(hostname, username, password, name, member) A function to connect to a bigip device and delete a specific pool.
member The name of the pool member to delete
salt '*' bigip.delete_pool_member bigip admin admin my-pool 10.2.2.2:80
salt.modules.bigip.delete_profile(hostname, username, password, profile_type, name) A function to connect to a bigip device and delete an existing profile.
profile_type The type of profile to delete
name   The name of the profile to delete
salt '*' bigip.delete_profile bigip admin admin http my-http-profile
salt.modules.bigip.delete_transaction(hostname, username, password, label) A function to connect to a bigip device and delete an existing transaction.
label  The label of this transaction stored within the grain: bigip_f5_trans:<label>
salt '*' bigip.delete_transaction bigip admin admin my_transaction
salt.modules.bigip.delete_virtual(hostname, username, password, name) A function to connect to a bigip device and delete a specific virtual.
name   The name of the virtual to delete
salt '*' bigip.delete_virtual bigip admin admin my-virtual
salt.modules.bigip.list_monitor(hostname, username, password, monitor_type, name=None) A function to connect to a bigip device and list an existing monitor.  If no name is provided than all monitors of the specified type will be listed.
monitor_type The type of monitor(s) to list
name   The name of the monitor to list
salt '*' bigip.list_monitor bigip admin admin http my-http-monitor
salt.modules.bigip.list_node(hostname, username, password, name=None, trans_label=None) A function to connect to a bigip device and list all nodes or a specific node.
name   The name of the node to list. If no name is specified than all nodes will be listed.
salt '*' bigip.list_node bigip admin admin my-node
salt.modules.bigip.list_pool(hostname, username, password, name=None) A function to connect to a bigip device and list all pools or a specific pool.
name   The name of the pool to list. If no name is specified then all pools will be listed.
salt '*' bigip.list_pool bigip admin admin my-pool
salt.modules.bigip.list_profile(hostname, username, password, profile_type, name=None) A function to connect to a bigip device and list an existing profile.  If no name is provided than all profiles of the specified type will be listed.
profile_type The type of profile(s) to list
name   The name of the profile to list
salt '*' bigip.list_profile bigip admin admin http my-http-profile
salt.modules.bigip.list_transaction(hostname, username, password, label) A function to connect to a bigip device and list an existing transaction.
salt '*' bigip.list_transaction bigip admin admin my_transaction
salt.modules.bigip.list_virtual(hostname, username, password, name=None) A function to connect to a bigip device and list all virtuals or a specific virtual.
name   The name of the virtual to list. If no name is specified than all virtuals will be listed.
salt '*' bigip.list_virtual bigip admin admin my-virtual
salt.modules.bigip.modify_monitor(hostname, username, password, monitor_type, name, **kwargs) A function to connect to a bigip device and modify an existing monitor.
monitor_type The type of monitor to modify
name   The name of the monitor to modify
salt '*' bigip.modify_monitor bigip admin admin http my-http-monitor  timout=16 interval=6