diff options
Diffstat (limited to 'lib')
907 files changed, 4819 insertions, 4818 deletions
diff --git a/lib/ansible/modules/cloud/alicloud/ali_instance.py b/lib/ansible/modules/cloud/alicloud/ali_instance.py index e28cdc696e..6a6505c059 100644 --- a/lib/ansible/modules/cloud/alicloud/ali_instance.py +++ b/lib/ansible/modules/cloud/alicloud/ali_instance.py @@ -268,7 +268,7 @@ instances: availability_zone: description: The availability zone of the instance is in. returned: always - type: string + type: str sample: cn-beijing-a block_device_mappings: description: Any block device mapping entries for the instance. @@ -278,12 +278,12 @@ instances: device_name: description: The device name exposed to the instance (for example, /dev/xvda). returned: always - type: string + type: str sample: /dev/xvda attach_time: description: The time stamp when the attachment initiated. returned: always - type: string + type: str sample: "2018-06-25T04:08:26Z" delete_on_termination: description: Indicates whether the volume is deleted on instance termination. @@ -293,12 +293,12 @@ instances: status: description: The attachment state. returned: always - type: string + type: str sample: in_use volume_id: description: The ID of the cloud disk. returned: always - type: string + type: str sample: d-2zei53pjsi117y6gf9t6 cpu: description: The CPU core count of the instance. @@ -308,12 +308,12 @@ instances: creation_time: description: The time the instance was created. returned: always - type: string + type: str sample: "2018-06-25T04:08Z" description: description: The instance description. returned: always - type: string + type: str sample: "my ansible instance" eip: description: The attribution of EIP associated with the instance. @@ -323,22 +323,22 @@ instances: allocation_id: description: The ID of the EIP. returned: always - type: string + type: str sample: eip-12345 internet_charge_type: description: The internet charge type of the EIP. returned: always - type: string + type: str sample: "paybybandwidth" ip_address: description: EIP address. returned: always - type: string + type: str sample: 42.10.2.2 expired_time: description: The time the instance will expire. returned: always - type: string + type: str sample: "2099-12-31T15:59Z" gpu: description: The attribution of instance GPU. @@ -353,52 +353,52 @@ instances: spec: description: The specification of the GPU. returned: always - type: string + type: str sample: "" host_name: description: The host name of the instance. returned: always - type: string + type: str sample: iZ2zewaoZ id: description: Alias of instance_id. returned: always - type: string + type: str sample: i-abc12345 instance_id: description: ECS instance resource ID. returned: always - type: string + type: str sample: i-abc12345 image_id: description: The ID of the image used to launch the instance. returned: always - type: string + type: str sample: m-0011223344 inner_ip_address: description: The inner IPv4 address of the classic instance. returned: always - type: string + type: str sample: 10.0.0.2 instance_charge_type: description: The instance charge type. returned: always - type: string + type: str sample: PostPaid instance_name: description: The name of the instance. returned: always - type: string + type: str sample: my-ecs instance_type: description: The instance type of the running instance. returned: always - type: string + type: str sample: ecs.sn1ne.xlarge internet_charge_type: description: The billing method of the network bandwidth. returned: always - type: string + type: str sample: PayByBandwidth internet_max_bandwidth_in: description: Maximum incoming bandwidth from the internet network. @@ -428,42 +428,42 @@ instances: mac_address: description: The MAC address. returned: always - type: string + type: str sample: "00:11:22:33:44:55" network_interface_id: description: The ID of the network interface. returned: always - type: string + type: str sample: eni-01234567 primary_ip_address: description: The primary IPv4 address of the network interface within the vswitch. returned: always - type: string + type: str sample: 10.0.0.1 osname: description: The operation system name of the instance owned. returned: always - type: string + type: str sample: CentOS ostype: description: The operation system type of the instance owned. returned: always - type: string + type: str sample: linux private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always - type: string + type: str sample: 10.0.0.1 public_ip_address: description: The public IPv4 address assigned to the instance returned: always - type: string + type: str sample: 43.0.0.1 resource_group_id: description: The id of the resource group to which the instance belongs. returned: always - type: string + type: str sample: my-ecs-group security_groups: description: One or more security groups for the instance. @@ -473,17 +473,17 @@ instances: - group_id: description: The ID of the security group. returned: always - type: string + type: str sample: sg-0123456 - group_name: description: The name of the security group. returned: always - type: string + type: str sample: my-security-group status: description: The current status of the instance. returned: always - type: string + type: str sample: running tags: description: Any tags assigned to the instance. @@ -493,7 +493,7 @@ instances: vswitch_id: description: The ID of the vswitch in which the instance is running. returned: always - type: string + type: str sample: vsw-dew00abcdef vpc_id: description: The ID of the VPC the instance is in. diff --git a/lib/ansible/modules/cloud/alicloud/ali_instance_facts.py b/lib/ansible/modules/cloud/alicloud/ali_instance_facts.py index 683ba34070..f1e3d83b3b 100644 --- a/lib/ansible/modules/cloud/alicloud/ali_instance_facts.py +++ b/lib/ansible/modules/cloud/alicloud/ali_instance_facts.py @@ -97,7 +97,7 @@ instances: availability_zone: description: The availability zone of the instance is in. returned: always - type: string + type: str sample: cn-beijing-a block_device_mappings: description: Any block device mapping entries for the instance. @@ -107,12 +107,12 @@ instances: device_name: description: The device name exposed to the instance (for example, /dev/xvda). returned: always - type: string + type: str sample: /dev/xvda attach_time: description: The time stamp when the attachment initiated. returned: always - type: string + type: str sample: "2018-06-25T04:08:26Z" delete_on_termination: description: Indicates whether the volume is deleted on instance termination. @@ -122,12 +122,12 @@ instances: status: description: The attachment state. returned: always - type: string + type: str sample: in_use volume_id: description: The ID of the cloud disk. returned: always - type: string + type: str sample: d-2zei53pjsi117y6gf9t6 cpu: description: The CPU core count of the instance. @@ -137,12 +137,12 @@ instances: creation_time: description: The time the instance was created. returned: always - type: string + type: str sample: "2018-06-25T04:08Z" description: description: The instance description. returned: always - type: string + type: str sample: "my ansible instance" eip: description: The attribution of EIP associated with the instance. @@ -152,22 +152,22 @@ instances: allocation_id: description: The ID of the EIP. returned: always - type: string + type: str sample: eip-12345 internet_charge_type: description: The internet charge type of the EIP. returned: always - type: string + type: str sample: "paybybandwidth" ip_address: description: EIP address. returned: always - type: string + type: str sample: 42.10.2.2 expired_time: description: The time the instance will expire. returned: always - type: string + type: str sample: "2099-12-31T15:59Z" gpu: description: The attribution of instance GPU. @@ -182,52 +182,52 @@ instances: spec: description: The specification of the GPU. returned: always - type: string + type: str sample: "" host_name: description: The host name of the instance. returned: always - type: string + type: str sample: iZ2zewaoZ id: description: Alias of instance_id. returned: always - type: string + type: str sample: i-abc12345 instance_id: description: ECS instance resource ID. returned: always - type: string + type: str sample: i-abc12345 image_id: description: The ID of the image used to launch the instance. returned: always - type: string + type: str sample: m-0011223344 inner_ip_address: description: The inner IPv4 address of the classic instance. returned: always - type: string + type: str sample: 10.0.0.2 instance_charge_type: description: The instance charge type. returned: always - type: string + type: str sample: PostPaid instance_name: description: The name of the instance. returned: always - type: string + type: str sample: my-ecs instance_type: description: The instance type of the running instance. returned: always - type: string + type: str sample: ecs.sn1ne.xlarge internet_charge_type: description: The billing method of the network bandwidth. returned: always - type: string + type: str sample: PayByBandwidth internet_max_bandwidth_in: description: Maximum incoming bandwidth from the internet network. @@ -257,42 +257,42 @@ instances: mac_address: description: The MAC address. returned: always - type: string + type: str sample: "00:11:22:33:44:55" network_interface_id: description: The ID of the network interface. returned: always - type: string + type: str sample: eni-01234567 primary_ip_address: description: The primary IPv4 address of the network interface within the vswitch. returned: always - type: string + type: str sample: 10.0.0.1 osname: description: The operation system name of the instance owned. returned: always - type: string + type: str sample: CentOS ostype: description: The operation system type of the instance owned. returned: always - type: string + type: str sample: linux private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always - type: string + type: str sample: 10.0.0.1 public_ip_address: description: The public IPv4 address assigned to the instance returned: always - type: string + type: str sample: 43.0.0.1 resource_group_id: description: The id of the resource group to which the instance belongs. returned: always - type: string + type: str sample: my-ecs-group security_groups: description: One or more security groups for the instance. @@ -302,17 +302,17 @@ instances: - group_id: description: The ID of the security group. returned: always - type: string + type: str sample: sg-0123456 - group_name: description: The name of the security group. returned: always - type: string + type: str sample: my-security-group status: description: The current status of the instance. returned: always - type: string + type: str sample: running tags: description: Any tags assigned to the instance. @@ -322,7 +322,7 @@ instances: vswitch_id: description: The ID of the vswitch in which the instance is running. returned: always - type: string + type: str sample: vsw-dew00abcdef vpc_id: description: The ID of the VPC the instance is in. diff --git a/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py b/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py index f4d8569dba..58e8b45182 100644 --- a/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py +++ b/lib/ansible/modules/cloud/amazon/_ec2_ami_find.py @@ -168,12 +168,12 @@ RETURN = ''' ami_id: description: id of found amazon image returned: when AMI found - type: string + type: str sample: "ami-e9095e8c" architecture: description: architecture of image returned: when AMI found - type: string + type: str sample: "x86_64" block_device_mapping: description: block device mapping associated with image @@ -190,17 +190,17 @@ block_device_mapping: creationDate: description: creation date of image returned: when AMI found - type: string + type: str sample: "2015-10-15T22:43:44.000Z" description: description: description of image returned: when AMI found - type: string + type: str sample: "test-server01" hypervisor: description: type of hypervisor returned: when AMI found - type: string + type: str sample: "xen" is_public: description: whether image is public @@ -210,37 +210,37 @@ is_public: location: description: location of image returned: when AMI found - type: string + type: str sample: "435210894375/test-server01-20151015-234343" name: description: ami name of image returned: when AMI found - type: string + type: str sample: "test-server01-20151015-234343" owner_id: description: owner of image returned: when AMI found - type: string + type: str sample: "435210894375" platform: description: platform of image returned: when AMI found - type: string + type: str sample: null root_device_name: description: root device name of image returned: when AMI found - type: string + type: str sample: "/dev/xvda" root_device_type: description: root device type of image returned: when AMI found - type: string + type: str sample: "ebs" state: description: state of image returned: when AMI found - type: string + type: str sample: "available" tags: description: tags assigned to image @@ -254,7 +254,7 @@ tags: virtualization_type: description: image virtualization type returned: when AMI found - type: string + type: str sample: "hvm" ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_acm_facts.py b/lib/ansible/modules/cloud/amazon/aws_acm_facts.py index dc5e4eb3e3..4eed4a13e8 100644 --- a/lib/ansible/modules/cloud/amazon/aws_acm_facts.py +++ b/lib/ansible/modules/cloud/amazon/aws_acm_facts.py @@ -56,27 +56,27 @@ certificates: description: The ACM Certificate body returned: when certificate creation is complete sample: '-----BEGIN CERTIFICATE-----\\nMII.....-----END CERTIFICATE-----\\n' - type: string + type: str certificate_arn: description: Certificate ARN returned: always sample: arn:aws:acm:ap-southeast-2:123456789012:certificate/abcd1234-abcd-1234-abcd-123456789abc - type: string + type: str certificate_chain: description: Full certificate chain for the certificate returned: when certificate creation is complete sample: '-----BEGIN CERTIFICATE-----\\nMII...\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\n...' - type: string + type: str created_at: description: Date certificate was created returned: always sample: '2017-08-15T10:31:19+10:00' - type: string + type: str domain_name: description: Domain name for the certificate returned: always sample: '*.example.com' - type: string + type: str domain_validation_options: description: Options used by ACM to validate the certificate returned: when certificate type is AMAZON_ISSUED @@ -86,12 +86,12 @@ certificates: description: Fully qualified domain name of the certificate returned: always sample: example.com - type: string + type: str validation_domain: description: The domain name ACM used to send validation emails returned: always sample: example.com - type: string + type: str validation_emails: description: A list of email addresses that ACM used to send domain validation emails returned: always @@ -103,11 +103,11 @@ certificates: description: Validation status of the domain returned: always sample: SUCCESS - type: string + type: str failure_reason: description: Reason certificate request failed returned: only when certificate issuing failed - type: string + type: str sample: NO_AVAILABLE_CONTACTS in_use_by: description: A list of ARNs for the AWS resources that are using the certificate. @@ -118,27 +118,27 @@ certificates: description: Date certificate was issued returned: always sample: '2017-01-01T00:00:00+10:00' - type: string + type: str issuer: description: Issuer of the certificate returned: always sample: Amazon - type: string + type: str key_algorithm: description: Algorithm used to generate the certificate returned: always sample: RSA-2048 - type: string + type: str not_after: description: Date after which the certificate is not valid returned: always sample: '2019-01-01T00:00:00+10:00' - type: string + type: str not_before: description: Date before which the certificate is not valid returned: always sample: '2017-01-01T00:00:00+10:00' - type: string + type: str renewal_summary: description: Information about managed renewal process returned: when certificate is issued by Amazon and a renewal has been started @@ -153,12 +153,12 @@ certificates: description: Fully qualified domain name of the certificate returned: always sample: example.com - type: string + type: str validation_domain: description: The domain name ACM used to send validation emails returned: always sample: example.com - type: string + type: str validation_emails: description: A list of email addresses that ACM used to send domain validation emails returned: always @@ -170,42 +170,42 @@ certificates: description: Validation status of the domain returned: always sample: SUCCESS - type: string + type: str renewal_status: description: Status of the domain renewal returned: always sample: PENDING_AUTO_RENEWAL - type: string + type: str revocation_reason: description: Reason for certificate revocation returned: when the certificate has been revoked sample: SUPERCEDED - type: string + type: str revoked_at: description: Date certificate was revoked returned: when the certificate has been revoked sample: '2017-09-01T10:00:00+10:00' - type: string + type: str serial: description: The serial number of the certificate returned: always sample: 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f - type: string + type: str signature_algorithm: description: Algorithm used to sign the certificate returned: always sample: SHA256WITHRSA - type: string + type: str status: description: Status of the certificate in ACM returned: always sample: ISSUED - type: string + type: str subject: description: The name of the entity that is associated with the public key contained in the certificate returned: always sample: CN=*.example.com - type: string + type: str subject_alternative_names: description: Subject Alternative Names for the certificate returned: always @@ -223,7 +223,7 @@ certificates: description: The source of the certificate returned: always sample: AMAZON_ISSUED - type: string + type: str ''' import traceback diff --git a/lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py b/lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py index d689a48401..a8b6c91a70 100644 --- a/lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py +++ b/lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py @@ -139,38 +139,38 @@ alarms: alarm_arn: description: The Amazon Resource Name (ARN) of the alarm returned: when state present - type: string + type: str alarm_name: description: The name of the alarm returned: when state present - type: string + type: str service_namespace: description: The namespace of the AWS service. returned: when state present - type: string + type: str sample: ecs resource_id: description: The identifier of the resource associated with the scalable target. returned: when state present - type: string + type: str sample: service/cluster-name/service-name scalable_dimension: description: The scalable dimension associated with the scalable target. returned: when state present - type: string + type: str sample: ecs:service:DesiredCount policy_arn: description: The Amazon Resource Name (ARN) of the scaling policy.. returned: when state present - type: string + type: str policy_name: description: The name of the scaling policy. returned: when state present - type: string + type: str policy_type: description: The policy type. returned: when state present - type: string + type: str min_capacity: description: The minimum value to scale to in response to a scale in event. Required if I(state) is C(present). returned: when state present @@ -184,7 +184,7 @@ max_capacity: role_arn: description: The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. Required if I(state) is C(present). returned: when state present - type: string + type: str sample: arn:aws:iam::123456789123:role/roleName step_scaling_policy_configuration: description: The step scaling policy. @@ -194,7 +194,7 @@ step_scaling_policy_configuration: adjustment_type: description: The adjustment type returned: when state present and the policy type is StepScaling - type: string + type: str sample: "ChangeInCapacity, PercentChangeInCapacity, ExactCapacity" cooldown: description: The amount of time, in seconds, after a scaling activity completes @@ -205,7 +205,7 @@ step_scaling_policy_configuration: metric_aggregation_type: description: The aggregation type for the CloudWatch metrics returned: when state present and the policy type is StepScaling - type: string + type: str sample: "Average, Minimum, Maximum" step_adjustments: description: A set of adjustments that enable you to scale based on the size of the alarm breach @@ -224,12 +224,12 @@ target_tracking_scaling_policy_configuration: predefined_metric_type: description: The metric type returned: when state present and the policy type is TargetTrackingScaling - type: string + type: str sample: "ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization" resource_label: description: Identifies the resource associated with the metric type returned: when metric type is ALBRequestCountPerTarget - type: string + type: str scale_in_cooldown: description: The amount of time, in seconds, after a scale in activity completes before another scale in activity can start returned: when state present and the policy type is TargetTrackingScaling @@ -248,7 +248,7 @@ target_tracking_scaling_policy_configuration: creation_time: description: The Unix timestamp for when the scalable target was created. returned: when state present - type: string + type: str sample: '2017-09-28T08:22:51.881000-03:00' ''' # NOQA diff --git a/lib/ansible/modules/cloud/amazon/aws_caller_facts.py b/lib/ansible/modules/cloud/amazon/aws_caller_facts.py index b4378528d5..31b6115d65 100644 --- a/lib/ansible/modules/cloud/amazon/aws_caller_facts.py +++ b/lib/ansible/modules/cloud/amazon/aws_caller_facts.py @@ -39,24 +39,24 @@ RETURN = ''' account: description: The account id the access credentials are associated with. returned: success - type: string + type: str sample: "123456789012" account_alias: description: The account alias the access credentials are associated with. returned: when caller has the iam:ListAccountAliases permission - type: string + type: str sample: "acme-production" arn: description: The arn identifying the user the credentials are associated with. returned: success - type: string + type: str sample: arn:aws:sts::123456789012:federated-user/my-federated-user-name user_id: description: | The user id the access credentials are associated with. Note that this may not correspond to anything you can look up in the case of roles or federated identities. returned: success - type: string + type: str sample: 123456789012:my-federated-user-name ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_codecommit.py b/lib/ansible/modules/cloud/amazon/aws_codecommit.py index 154a410fe4..7a4454d40e 100644 --- a/lib/ansible/modules/cloud/amazon/aws_codecommit.py +++ b/lib/ansible/modules/cloud/amazon/aws_codecommit.py @@ -51,22 +51,22 @@ repository_metadata: account_id: description: "The ID of the AWS account associated with the repository." returned: when state is present - type: string + type: str sample: "268342293637" arn: description: "The Amazon Resource Name (ARN) of the repository." returned: when state is present - type: string + type: str sample: "arn:aws:codecommit:ap-northeast-1:268342293637:username" clone_url_http: description: "The URL to use for cloning the repository over HTTPS." returned: when state is present - type: string + type: str sample: "https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame" clone_url_ssh: description: "The URL to use for cloning the repository over SSH." returned: when state is present - type: string + type: str sample: "ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame" creation_date: description: "The date and time the repository was created, in timestamp format." @@ -76,22 +76,22 @@ repository_metadata: last_modified_date: description: "The date and time the repository was last modified, in timestamp format." returned: when state is present - type: string + type: str sample: "2018-10-16T13:21:41.261000+09:00" repository_description: description: "A comment or description about the repository." returned: when state is present - type: string + type: str sample: "test from ptux" repository_id: description: "The ID of the repository that was created or deleted" returned: always - type: string + type: str sample: "e62a5c54-i879-497b-b62f-9f99e4ebfk8e" repository_name: description: "The repository's name." returned: when state is present - type: string + type: str sample: "reponame" response_metadata: @@ -106,17 +106,17 @@ response_metadata: http_status_code: description: "http status code of http response" returned: always - type: string + type: str sample: "200" request_id: description: "http request id" returned: always - type: string + type: str sample: "fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef" retry_attempts: description: "numbers of retry attempts" returned: always - type: string + type: str sample: "0" ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py b/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py index 45e9ab2bef..0707bf50b7 100644 --- a/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py +++ b/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py @@ -101,47 +101,47 @@ connection: aws_device: description: The endpoint which the physical connection terminates on. returned: when the requested state is no longer 'requested' - type: string + type: str sample: EqDC2-12pmo7hemtz1z bandwidth: description: The bandwidth of the connection. returned: always - type: string + type: str sample: 1Gbps connection_id: description: The ID of the connection. returned: always - type: string + type: str sample: dxcon-ffy9ywed connection_name: description: The name of the connection. returned: always - type: string + type: str sample: ansible-test-connection connection_state: description: The state of the connection. returned: always - type: string + type: str sample: pending loa_issue_time: description: The issue time of the connection's Letter of Authorization - Connecting Facility Assignment. returned: when the LOA-CFA has been issued (the connection state will no longer be 'requested') - type: string + type: str sample: '2018-03-20T17:36:26-04:00' location: description: The location of the connection. returned: always - type: string + type: str sample: EqDC2 owner_account: description: The account that owns the direct connect connection. returned: always - type: string + type: str sample: '123456789012' region: description: The region in which the connection exists. returned: always - type: string + type: str sample: us-east-1 """ diff --git a/lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py b/lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py index f527d0d5ab..e1628fb123 100644 --- a/lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py +++ b/lib/ansible/modules/cloud/amazon/aws_direct_connect_virtual_interface.py @@ -72,12 +72,12 @@ RETURN = ''' address_family: description: The address family for the BGP peer. returned: always - type: string + type: str sample: ipv4 amazon_address: description: IP address assigned to the Amazon interface. returned: always - type: string + type: str sample: 169.254.255.1/30 asn: description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. @@ -87,7 +87,7 @@ asn: auth_key: description: The authentication key for BGP configuration. returned: always - type: string + type: str sample: 0xZ59Y1JZ2oDOSh6YriIlyRE bgp_peers: description: A list of the BGP peers configured on this virtual interface. @@ -97,12 +97,12 @@ bgp_peers: address_family: description: The address family for the BGP peer. returned: always - type: string + type: str sample: ipv4 amazon_address: description: IP address assigned to the Amazon interface. returned: always - type: string + type: str sample: 169.254.255.1/30 asn: description: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. @@ -112,22 +112,22 @@ bgp_peers: auth_key: description: The authentication key for BGP configuration. returned: always - type: string + type: str sample: 0xZ59Y1JZ2oDOSh6YriIlyRE bgp_peer_state: description: The state of the BGP peer (verifying, pending, available) returned: always - type: string + type: str sample: available bgp_status: description: The up/down state of the BGP peer. returned: always - type: string + type: str sample: up customer_address: description: IP address assigned to the customer interface. returned: always - type: string + type: str sample: 169.254.255.2/30 changed: description: Indicated if the virtual interface has been created/modified/deleted @@ -139,26 +139,26 @@ connection_id: - The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection). returned: always - type: string + type: str sample: dxcon-fgb175av customer_address: description: IP address assigned to the customer interface. returned: always - type: string + type: str sample: 169.254.255.2/30 customer_router_config: description: Information for generating the customer router configuration. returned: always - type: string + type: str location: description: Where the connection is located. returned: always - type: string + type: str sample: EqDC2 owner_account: description: The AWS account that will own the new virtual interface. returned: always - type: string + type: str sample: '123456789012' route_filter_prefixes: description: A list of routes to be advertised to the AWS network in this region (public virtual interface). @@ -168,32 +168,32 @@ route_filter_prefixes: cidr: description: A routes to be advertised to the AWS network in this region. returned: always - type: string + type: str sample: 54.227.92.216/30 virtual_gateway_id: description: The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces. returned: when I(public=False) - type: string + type: str sample: vgw-f3ce259a virtual_interface_id: description: The ID of the virtual interface. returned: always - type: string + type: str sample: dxvif-fh0w7cex virtual_interface_name: description: The name of the virtual interface assigned by the customer. returned: always - type: string + type: str sample: test_virtual_interface virtual_interface_state: description: State of the virtual interface (confirming, verifying, pending, available, down, rejected). returned: always - type: string + type: str sample: available virtual_interface_type: description: The type of virtual interface (private, public). returned: always - type: string + type: str sample: private vlan: description: The VLAN ID. diff --git a/lib/ansible/modules/cloud/amazon/aws_eks_cluster.py b/lib/ansible/modules/cloud/amazon/aws_eks_cluster.py index f4f479a667..f0c2a06154 100644 --- a/lib/ansible/modules/cloud/amazon/aws_eks_cluster.py +++ b/lib/ansible/modules/cloud/amazon/aws_eks_cluster.py @@ -80,7 +80,7 @@ RETURN = ''' arn: description: ARN of the EKS cluster returned: when state is present - type: string + type: str sample: arn:aws:eks:us-west-2:111111111111:cluster/my-eks-cluster certificate_authority: description: Dictionary containing Certificate Authority Data for cluster @@ -90,21 +90,21 @@ certificate_authority: data: description: Base-64 encoded Certificate Authority Data for cluster returned: when the cluster has been created and is active - type: string + type: str endpoint: description: Kubernetes API server endpoint returned: when the cluster has been created and is active - type: string + type: str sample: https://API_SERVER_ENDPOINT.yl4.us-west-2.eks.amazonaws.com created_at: description: Cluster creation date and time returned: when state is present - type: string + type: str sample: '2018-06-06T11:56:56.242000+00:00' name: description: EKS cluster name returned: when state is present - type: string + type: str sample: my-eks-cluster resources_vpc_config: description: VPC configuration of the cluster @@ -129,24 +129,24 @@ resources_vpc_config: vpc_id: description: VPC id returned: always - type: string + type: str sample: vpc-a1b2c3d4 role_arn: description: ARN of the IAM role used by the cluster returned: when state is present - type: string + type: str sample: arn:aws:iam::111111111111:role/aws_eks_cluster_role status: description: status of the EKS cluster returned: when state is present - type: string + type: str sample: - CREATING - ACTIVE version: description: Kubernetes version of the cluster returned: when state is present - type: string + type: str sample: '1.10' ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_elasticbeanstalk_app.py b/lib/ansible/modules/cloud/amazon/aws_elasticbeanstalk_app.py index c20ab0b7a9..8d0ef2223d 100644 --- a/lib/ansible/modules/cloud/amazon/aws_elasticbeanstalk_app.py +++ b/lib/ansible/modules/cloud/amazon/aws_elasticbeanstalk_app.py @@ -77,7 +77,7 @@ app: output: description: message indicating what change will occur returned: in check mode - type: string + type: str sample: App is up-to-date ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_glue_connection.py b/lib/ansible/modules/cloud/amazon/aws_glue_connection.py index 1eb2d20d14..74906735ef 100644 --- a/lib/ansible/modules/cloud/amazon/aws_glue_connection.py +++ b/lib/ansible/modules/cloud/amazon/aws_glue_connection.py @@ -90,22 +90,22 @@ connection_properties: connection_type: description: The type of the connection. returned: when state is present - type: string + type: str sample: JDBC creation_time: description: The time this connection definition was created. returned: when state is present - type: string + type: str sample: "2018-04-21T05:19:58.326000+00:00" description: description: Description of the job being defined. returned: when state is present - type: string + type: str sample: My first Glue job last_updated_time: description: The last time this connection definition was updated. returned: when state is present - type: string + type: str sample: "2018-04-21T05:19:58.326000+00:00" match_criteria: description: A list of criteria that can be used in selecting this connection. @@ -115,7 +115,7 @@ match_criteria: name: description: The name of the connection definition. returned: when state is present - type: string + type: str sample: my-glue-connection physical_connection_requirements: description: A dict of physical connection requirements, such as VPC and SecurityGroup, diff --git a/lib/ansible/modules/cloud/amazon/aws_glue_job.py b/lib/ansible/modules/cloud/amazon/aws_glue_job.py index 857e0d4dea..9c20e15a19 100644 --- a/lib/ansible/modules/cloud/amazon/aws_glue_job.py +++ b/lib/ansible/modules/cloud/amazon/aws_glue_job.py @@ -109,12 +109,12 @@ command: name: description: The name of the job command. returned: when state is present - type: string + type: str sample: glueetl script_location: description: Specifies the S3 path to a script that executes a job. returned: when state is present - type: string + type: str sample: mybucket/myscript.py connections: description: The connections used for this job. @@ -124,7 +124,7 @@ connections: created_on: description: The time and date that this job definition was created. returned: when state is present - type: string + type: str sample: "2018-04-21T05:19:58.326000+00:00" default_arguments: description: The default arguments for this job, specified as name-value pairs. @@ -134,12 +134,12 @@ default_arguments: description: description: Description of the job being defined. returned: when state is present - type: string + type: str sample: My first Glue job job_name: description: The name of the AWS Glue job. returned: always - type: string + type: str sample: my-glue-job execution_property: description: An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job. @@ -156,7 +156,7 @@ execution_property: last_modified_on: description: The last point in time when this job definition was modified. returned: when state is present - type: string + type: str sample: "2018-04-21T05:19:58.326000+00:00" max_retries: description: The maximum number of times to retry this job after a JobRun fails. @@ -166,12 +166,12 @@ max_retries: name: description: The name assigned to this job definition. returned: when state is present - type: string + type: str sample: my-glue-job role: description: The name or ARN of the IAM role associated with this job. returned: when state is present - type: string + type: str sample: my-iam-role timeout: description: The job timeout in minutes. diff --git a/lib/ansible/modules/cloud/amazon/aws_inspector_target.py b/lib/ansible/modules/cloud/amazon/aws_inspector_target.py index 2af37e2250..143cc4fdb0 100644 --- a/lib/ansible/modules/cloud/amazon/aws_inspector_target.py +++ b/lib/ansible/modules/cloud/amazon/aws_inspector_target.py @@ -64,23 +64,23 @@ RETURN = ''' arn: description: The ARN that specifies the Amazon Inspector assessment target. returned: success - type: string + type: str sample: "arn:aws:inspector:eu-west-1:123456789012:target/0-O4LnL7n1" created_at: description: The time at which the assessment target was created. returned: success - type: string + type: str sample: "2018-01-29T13:48:51.958000+00:00" name: description: The name of the Amazon Inspector assessment target. returned: success - type: string + type: str sample: "my_target" resource_group_arn: description: The ARN that specifies the resource group that is associated with the assessment target. returned: success - type: string + type: str sample: "arn:aws:inspector:eu-west-1:123456789012:resourcegroup/0-qY4gDel8" tags: description: The tags of the resource group that is associated with the @@ -91,7 +91,7 @@ tags: updated_at: description: The time at which the assessment target was last updated. returned: success - type: string + type: str sample: "2018-01-29T13:48:51.958000+00:00" ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_kms.py b/lib/ansible/modules/cloud/amazon/aws_kms.py index ec8205d2d3..2615f630e3 100644 --- a/lib/ansible/modules/cloud/amazon/aws_kms.py +++ b/lib/ansible/modules/cloud/amazon/aws_kms.py @@ -91,7 +91,7 @@ changes_needed: sample: { "role": "add", "role grant": "add" } had_invalid_entries: description: there are invalid (non-ARN) entries in the KMS entry. These don't count as a change, but will be removed if any changes are being made. - type: boolean + type: bool returned: always ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_s3.py b/lib/ansible/modules/cloud/amazon/aws_s3.py index 13b5934766..a35fc9b2ee 100644 --- a/lib/ansible/modules/cloud/amazon/aws_s3.py +++ b/lib/ansible/modules/cloud/amazon/aws_s3.py @@ -270,12 +270,12 @@ RETURN = ''' msg: description: msg indicating the status of the operation returned: always - type: string + type: str sample: PUT operation complete url: description: url of the object returned: (for put and geturl operations) - type: string + type: str sample: https://my-bucket.s3.amazonaws.com/my-key.txt?AWSAccessKeyId=<access-key>&Expires=1506888865&Signature=<signature> expiry: description: number of seconds the presigned url is valid for @@ -285,7 +285,7 @@ expiry: contents: description: contents of the object as string returned: (for getstr operation) - type: string + type: str sample: "Hello, world!" s3_keys: description: list of object keys diff --git a/lib/ansible/modules/cloud/amazon/aws_s3_cors.py b/lib/ansible/modules/cloud/amazon/aws_s3_cors.py index 0a4832d4dc..c5e978c4d4 100644 --- a/lib/ansible/modules/cloud/amazon/aws_s3_cors.py +++ b/lib/ansible/modules/cloud/amazon/aws_s3_cors.py @@ -62,12 +62,12 @@ RETURN = ''' changed: description: check to see if a change was made to the rules returned: always - type: boolean + type: bool sample: true name: description: name of bucket returned: always - type: string + type: str sample: 'bucket-name' rules: description: list of current rules diff --git a/lib/ansible/modules/cloud/amazon/aws_ses_identity.py b/lib/ansible/modules/cloud/amazon/aws_ses_identity.py index 3e15c32c6b..55573bfa97 100644 --- a/lib/ansible/modules/cloud/amazon/aws_ses_identity.py +++ b/lib/ansible/modules/cloud/amazon/aws_ses_identity.py @@ -148,12 +148,12 @@ RETURN = ''' identity: description: The identity being modified. returned: success - type: string + type: str sample: example@example.com identity_arn: description: The arn of the identity being modified. returned: success - type: string + type: str sample: arn:aws:ses:us-east-1:12345678:identity/example@example.com verification_attributes: description: The verification information for the identity. @@ -166,11 +166,11 @@ verification_attributes: contains: verification_status: description: The verification status of the identity. - type: string + type: str sample: "Pending" verification_token: description: The verification token for a domain identity. - type: string + type: str notification_attributes: description: The notification setup for the identity. returned: success @@ -189,17 +189,17 @@ notification_attributes: description: - The ARN of the topic bounce notifications are delivered to. - Omitted if bounce notifications are not delivered to a topic. - type: string + type: str complaint_topic: description: - The ARN of the topic complaint notifications are delivered to. - Omitted if complaint notifications are not delivered to a topic. - type: string + type: str delivery_topic: description: - The ARN of the topic delivery notifications are delivered to. - Omitted if delivery notifications are not delivered to a topic. - type: string + type: str forwarding_enabled: description: Whether or not feedback forwarding is enabled. type: bool diff --git a/lib/ansible/modules/cloud/amazon/aws_sgw_facts.py b/lib/ansible/modules/cloud/amazon/aws_sgw_facts.py index fdfe8f5320..27afdce2a3 100644 --- a/lib/ansible/modules/cloud/amazon/aws_sgw_facts.py +++ b/lib/ansible/modules/cloud/amazon/aws_sgw_facts.py @@ -57,27 +57,27 @@ gateways: gateway_arn: description: "Storage Gateway ARN" returned: always - type: string + type: str sample: "arn:aws:storagegateway:eu-west-1:367709993819:gateway/sgw-9999F888" gateway_id: description: "Storage Gateway ID" returned: always - type: string + type: str sample: "sgw-9999F888" gateway_name: description: "Storage Gateway friendly name" returned: always - type: string + type: str sample: "my-sgw-01" gateway_operational_state: description: "Storage Gateway operational state" returned: always - type: string + type: str sample: "ACTIVE" gateway_type: description: "Storage Gateway type" returned: always - type: string + type: str sample: "FILE_S3" file_shares: description: "Storage gateway file shares" @@ -87,17 +87,17 @@ gateways: file_share_arn: description: "File share ARN" returned: always - type: string + type: str sample: "arn:aws:storagegateway:eu-west-1:399805793479:share/share-AF999C88" file_share_id: description: "File share ID" returned: always - type: string + type: str sample: "share-AF999C88" file_share_status: description: "File share status" returned: always - type: string + type: str sample: "AVAILABLE" tapes: description: "Storage Gateway tapes" @@ -107,22 +107,22 @@ gateways: tape_arn: description: "Tape ARN" returned: always - type: string + type: str sample: "arn:aws:storagegateway:eu-west-1:399805793479:tape/tape-AF999C88" tape_barcode: description: "Tape ARN" returned: always - type: string + type: str sample: "tape-AF999C88" tape_size_in_bytes: description: "Tape ARN" returned: always - type: integer + type: int sample: 555887569 tape_status: description: "Tape ARN" returned: always - type: string + type: str sample: "AVAILABLE" local_disks: description: "Storage gateway local disks" @@ -132,32 +132,32 @@ gateways: disk_allocation_type: description: "Disk allocation type" returned: always - type: string + type: str sample: "CACHE STORAGE" disk_id: description: "Disk ID on the system" returned: always - type: string + type: str sample: "pci-0000:00:1f.0" disk_node: description: "Disk parent block device" returned: always - type: string + type: str sample: "/dev/sdb" disk_path: description: "Disk path used for the cache" returned: always - type: string + type: str sample: "/dev/nvme1n1" disk_size_in_bytes: description: "Disk size in bytes" returned: always - type: integer + type: int sample: 107374182400 disk_status: description: "Disk status" returned: always - type: string + type: str sample: "present" ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py b/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py index 7a3256984f..9ce33df36c 100644 --- a/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py +++ b/lib/ansible/modules/cloud/amazon/aws_ssm_parameter_store.py @@ -113,11 +113,11 @@ RETURN = ''' put_parameter: description: Add one or more parameters to the system. returned: success - type: dictionary + type: dict delete_parameter: description: Delete a parameter from the system. returned: success - type: dictionary + type: dict ''' from ansible.module_utils.aws.core import AnsibleAWSModule diff --git a/lib/ansible/modules/cloud/amazon/aws_waf_condition.py b/lib/ansible/modules/cloud/amazon/aws_waf_condition.py index b30e48fd5d..90b4c87008 100644 --- a/lib/ansible/modules/cloud/amazon/aws_waf_condition.py +++ b/lib/ansible/modules/cloud/amazon/aws_waf_condition.py @@ -143,12 +143,12 @@ condition: condition_id: description: type-agnostic ID for the condition returned: when state is present - type: string + type: str sample: dd74b1ff-8c06-4a4f-897a-6b23605de413 byte_match_set_id: description: ID for byte match set returned: always - type: string + type: str sample: c4882c96-837b-44a2-a762-4ea87dbf812b byte_match_tuples: description: list of byte match tuples @@ -162,23 +162,23 @@ condition: contains: data: description: Which specific header (if type is header) - type: string + type: str sample: content-type type: description: Type of field - type: string + type: str sample: HEADER positional_constraint: description: Position in the field to match - type: string + type: str sample: STARTS_WITH target_string: description: String to look for - type: string + type: str sample: Hello text_transformation: description: Transformation to apply to the field before matching - type: string + type: str sample: NONE geo_match_constraints: description: List of geographical constraints @@ -187,16 +187,16 @@ condition: contains: type: description: Type of geo constraint - type: string + type: str sample: Country value: description: Value of geo constraint (typically a country code) - type: string + type: str sample: AT geo_match_set_id: description: ID of the geo match set returned: when type is geo and state is present - type: string + type: str sample: dd74b1ff-8c06-4a4f-897a-6b23605de413 ip_set_descriptors: description: list of IP address filters @@ -206,27 +206,27 @@ condition: type: description: Type of IP address (IPV4 or IPV6) returned: always - type: string + type: str sample: IPV4 value: description: IP address returned: always - type: string + type: str sample: 10.0.0.0/8 ip_set_id: description: ID of condition returned: when type is ip and state is present - type: string + type: str sample: 78ad334a-3535-4036-85e6-8e11e745217b name: description: Name of condition returned: when state is present - type: string + type: str sample: my_waf_condition regex_match_set_id: description: ID of the regex match set returned: when type is regex and state is present - type: string + type: str sample: 5ea3f6a8-3cd3-488b-b637-17b79ce7089c regex_match_tuples: description: List of regex matches @@ -240,20 +240,20 @@ condition: type: description: The field name returned: when type is regex and state is present - type: string + type: str sample: QUERY_STRING regex_pattern_set_id: description: ID of the regex pattern - type: string + type: str sample: 6fdf7f2d-9091-445c-aef2-98f3c051ac9e text_transformation: description: transformation applied to the text before matching - type: string + type: str sample: NONE size_constraint_set_id: description: ID of the size constraint set returned: when type is size and state is present - type: string + type: str sample: de84b4b3-578b-447e-a9a0-0db35c995656 size_constraints: description: List of size constraints to apply @@ -262,7 +262,7 @@ condition: contains: comparison_operator: description: Comparison operator to apply - type: string + type: str sample: GT field_to_match: description: Field on which the size constraint is applied @@ -270,7 +270,7 @@ condition: contains: type: description: Field name - type: string + type: str sample: QUERY_STRING size: description: size to compare against the field @@ -278,12 +278,12 @@ condition: sample: 300 text_transformation: description: transformation applied to the text before matching - type: string + type: str sample: NONE sql_injection_match_set_id: description: ID of the SQL injection match set returned: when type is sql and state is present - type: string + type: str sample: de84b4b3-578b-447e-a9a0-0db35c995656 sql_injection_match_tuples: description: List of SQL injection match sets @@ -296,16 +296,16 @@ condition: contains: type: description: Field name - type: string + type: str sample: QUERY_STRING text_transformation: description: transformation applied to the text before matching - type: string + type: str sample: URL_DECODE xss_match_set_id: description: ID of the XSS match set returned: when type is xss and state is present - type: string + type: str sample: de84b4b3-578b-447e-a9a0-0db35c995656 xss_match_tuples: description: List of XSS match sets @@ -318,11 +318,11 @@ condition: contains: type: description: Field name - type: string + type: str sample: QUERY_STRING text_transformation: description: transformation applied to the text before matching - type: string + type: str sample: URL_DECODE ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_waf_facts.py b/lib/ansible/modules/cloud/amazon/aws_waf_facts.py index 908d83f88a..0e870629b1 100644 --- a/lib/ansible/modules/cloud/amazon/aws_waf_facts.py +++ b/lib/ansible/modules/cloud/amazon/aws_waf_facts.py @@ -44,7 +44,7 @@ wafs: name: description: A friendly name or description of the WebACL returned: always - type: string + type: str sample: test_waf default_action: description: The action to perform if none of the Rules contained in the WebACL match. @@ -54,7 +54,7 @@ wafs: metric_name: description: A friendly name or description for the metrics for this WebACL returned: always - type: string + type: str sample: test_waf_metric rules: description: An array that contains the action for each Rule in a WebACL , the priority of the Rule @@ -64,17 +64,17 @@ wafs: action: description: The action to perform if the Rule matches returned: always - type: string + type: str sample: BLOCK metric_name: description: A friendly name or description for the metrics for this Rule returned: always - type: string + type: str sample: ipblockrule name: description: A friendly name or description of the Rule returned: always - type: string + type: str sample: ip_block_rule predicates: description: The Predicates list contains a Predicate for each diff --git a/lib/ansible/modules/cloud/amazon/aws_waf_rule.py b/lib/ansible/modules/cloud/amazon/aws_waf_rule.py index d41760c227..53a0dde945 100644 --- a/lib/ansible/modules/cloud/amazon/aws_waf_rule.py +++ b/lib/ansible/modules/cloud/amazon/aws_waf_rule.py @@ -83,12 +83,12 @@ rule: metric_name: description: Metric name for the rule returned: always - type: string + type: str sample: ansibletest1234rule name: description: Friendly name for the rule returned: always - type: string + type: str sample: ansible-test-1234_rule predicates: description: List of conditions used in the rule @@ -98,7 +98,7 @@ rule: data_id: description: ID of the condition returned: always - type: string + type: str sample: 8251acdb-526c-42a8-92bc-d3d13e584166 negated: description: Whether the sense of the condition is negated @@ -108,12 +108,12 @@ rule: type: description: type of the condition returned: always - type: string + type: str sample: ByteMatch rule_id: description: ID of the WAF rule returned: always - type: string + type: str sample: 15de0cbc-9204-4e1f-90e6-69b2f415c261 ''' diff --git a/lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py b/lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py index 1c4ce5e045..607c7bd7be 100644 --- a/lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py +++ b/lib/ansible/modules/cloud/amazon/aws_waf_web_acl.py @@ -90,12 +90,12 @@ web_acl: metric_name: description: Metric name used as an identifier returned: always - type: string + type: str sample: mywebacl name: description: Friendly name of the Web ACL returned: always - type: string + type: str sample: my web acl rules: description: List of rules @@ -116,17 +116,17 @@ web_acl: rule_id: description: Rule ID returned: always - type: string + type: str sample: a6fc7ab5-287b-479f-8004-7fd0399daf75 type: description: Type of rule (either REGULAR or RATE_BASED) returned: always - type: string + type: str sample: REGULAR web_acl_id: description: Unique identifier of Web ACL returned: always - type: string + type: str sample: 10fff965-4b6b-46e2-9d78-24f6d2e2d21c ''' diff --git a/lib/ansible/modules/cloud/amazon/cloudfront_distribution.py b/lib/ansible/modules/cloud/amazon/cloudfront_distribution.py index 74036f9ddd..89c1a25f26 100644 --- a/lib/ansible/modules/cloud/amazon/cloudfront_distribution.py +++ b/lib/ansible/modules/cloud/amazon/cloudfront_distribution.py @@ -440,7 +440,7 @@ aliases: arn: description: Amazon Resource Name of the distribution returned: always - type: string + type: str sample: arn:aws:cloudfront::123456789012:distribution/E1234ABCDEFGHI cache_behaviors: description: Cloudfront cache behaviors @@ -509,7 +509,7 @@ cache_behaviors: forward: description: Which cookies to forward to the origin for this cache behavior returned: always - type: string + type: str sample: none whitelisted_names: description: The names of the cookies to forward to the origin for this cache behavior @@ -592,7 +592,7 @@ cache_behaviors: path_pattern: description: Path pattern that determines this cache behavior returned: always - type: string + type: str sample: /path/to/files/* smooth_streaming: description: Whether smooth streaming is enabled @@ -602,7 +602,7 @@ cache_behaviors: target_origin_id: description: Id of origin reference by this cache behavior returned: always - type: string + type: str sample: origin_abcd trusted_signers: description: Trusted signers @@ -622,7 +622,7 @@ cache_behaviors: viewer_protocol_policy: description: Policy of how to handle http/https returned: always - type: string + type: str sample: redirect-to-https quantity: description: Count of cache behaviors @@ -633,12 +633,12 @@ cache_behaviors: caller_reference: description: Idempotency reference given when creating cloudfront distribution returned: always - type: string + type: str sample: '1484796016700' comment: description: Any comments you want to include about the distribution returned: always - type: string + type: str sample: 'my first cloudfront distribution' custom_error_responses: description: Custom error responses to use for error handling @@ -663,12 +663,12 @@ custom_error_responses: response_code: description: Response code to return to the requester returned: always - type: string + type: str sample: '500' response_page_path: description: Path that contains the error page to display returned: always - type: string + type: str sample: /errors/5xx.html quantity: description: Count of custom error response items @@ -737,7 +737,7 @@ default_cache_behavior: forward: description: Which cookies to forward to the origin for this cache behavior returned: always - type: string + type: str sample: none whitelisted_names: description: The names of the cookies to forward to the origin for this cache behavior @@ -820,7 +820,7 @@ default_cache_behavior: path_pattern: description: Path pattern that determines this cache behavior returned: always - type: string + type: str sample: /path/to/files/* smooth_streaming: description: Whether smooth streaming is enabled @@ -830,7 +830,7 @@ default_cache_behavior: target_origin_id: description: Id of origin reference by this cache behavior returned: always - type: string + type: str sample: origin_abcd trusted_signers: description: Trusted signers @@ -850,13 +850,13 @@ default_cache_behavior: viewer_protocol_policy: description: Policy of how to handle http/https returned: always - type: string + type: str sample: redirect-to-https default_root_object: description: The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution returned: always - type: string + type: str sample: '' diff: description: Difference between previous configuration and new configuration @@ -866,7 +866,7 @@ diff: domain_name: description: Domain name of cloudfront distribution returned: always - type: string + type: str sample: d1vz8pzgurxosf.cloudfront.net enabled: description: Whether the cloudfront distribution is enabled or not @@ -876,12 +876,12 @@ enabled: http_version: description: Version of HTTP supported by the distribution returned: always - type: string + type: str sample: http2 id: description: Cloudfront distribution ID returned: always - type: string + type: str sample: E123456ABCDEFG in_progress_invalidation_batches: description: The number of invalidation batches currently in progress @@ -896,7 +896,7 @@ is_ipv6_enabled: last_modified_time: description: Date and time distribution was last modified returned: always - type: string + type: str sample: '2017-10-13T01:51:12.656000+00:00' logging: description: Logging information @@ -906,7 +906,7 @@ logging: bucket: description: S3 bucket logging destination returned: always - type: string + type: str sample: logs-example-com.s3.amazonaws.com enabled: description: Whether logging is enabled @@ -921,7 +921,7 @@ logging: prefix: description: Prefix added to logging object names returned: always - type: string + type: str sample: cloudfront/test origins: description: Origins in the cloudfront distribution @@ -966,7 +966,7 @@ origins: origin_protocol_policy: description: Policy of which protocols are supported returned: always - type: string + type: str sample: https-only origin_read_timeout: description: Timeout for reads to the origin @@ -994,17 +994,17 @@ origins: domain_name: description: Domain name of the origin returned: always - type: string + type: str sample: test-origin.example.com id: description: ID of the origin returned: always - type: string + type: str sample: test-origin.example.com origin_path: description: Subdirectory to prefix the request from the S3 or HTTP origin returned: always - type: string + type: str sample: '' quantity: description: Count of origins @@ -1014,7 +1014,7 @@ origins: price_class: description: Price class of cloudfront distribution returned: always - type: string + type: str sample: PriceClass_All restrictions: description: Restrictions in use by Cloudfront @@ -1039,12 +1039,12 @@ restrictions: restriction_type: description: Type of restriction returned: always - type: string + type: str sample: blacklist status: description: Status of the cloudfront distribution returned: always - type: string + type: str sample: InProgress tags: description: Distribution tags @@ -1060,32 +1060,32 @@ viewer_certificate: acm_certificate_arn: description: ARN of ACM certificate returned: when certificate comes from ACM - type: string + type: str sample: arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef certificate: description: Reference to certificate returned: always - type: string + type: str sample: arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef certificate_source: description: Where certificate comes from returned: always - type: string + type: str sample: acm minimum_protocol_version: description: Minimum SSL/TLS protocol supported by this distribution returned: always - type: string + type: str sample: TLSv1 ssl_support_method: description: Support for pre-SNI browsers or not returned: always - type: string + type: str sample: sni-only web_acl_id: description: ID of Web Access Control List (from WAF service) returned: always - type: string + type: str sample: abcd1234-1234-abcd-abcd-abcd12345678 ''' diff --git a/lib/ansible/modules/cloud/amazon/cloudfront_invalidation.py b/lib/ansible/modules/cloud/amazon/cloudfront_invalidation.py index caf03df57b..4d292f3943 100644 --- a/lib/ansible/modules/cloud/amazon/cloudfront_invalidation.py +++ b/lib/ansible/modules/cloud/amazon/cloudfront_invalidation.py @@ -82,12 +82,12 @@ invalidation: create_time: description: The date and time the invalidation request was first made. returned: always - type: string + type: str sample: '2018-02-01T15:50:41.159000+00:00' id: description: The identifier for the invalidation request. returned: always - type: string + type: str sample: I2G9MOWJZFV612 invalidation_batch: description: The current invalidation information for the batch request. @@ -97,7 +97,7 @@ invalidation: caller_reference: description: The value used to uniquely identify an invalidation request. returned: always - type: string + type: str sample: testing 123 paths: description: A dict that contains information about the objects that you want to invalidate. @@ -120,12 +120,12 @@ invalidation: status: description: The status of the invalidation request. returned: always - type: string + type: str sample: Completed location: description: The fully qualified URI of the distribution and invalidation batch request. returned: always - type: string + type: str sample: https://cloudfront.amazonaws.com/2017-03-25/distribution/E1ZID6KZJECZY7/invalidation/I2G9MOWJZFV622 ''' diff --git a/lib/ansible/modules/cloud/amazon/cloudfront_origin_access_identity.py b/lib/ansible/modules/cloud/amazon/cloudfront_origin_access_identity.py index b89c7ffcb7..15607c272e 100644 --- a/lib/ansible/modules/cloud/amazon/cloudfront_origin_access_identity.py +++ b/lib/ansible/modules/cloud/amazon/cloudfront_origin_access_identity.py @@ -91,27 +91,27 @@ cloud_front_origin_access_identity: caller_reference: description: a caller reference for the oai returned: always - type: string + type: str comment: description: a comment describing the oai returned: always - type: string + type: str id: description: a unique identifier of the oai returned: always - type: string + type: str s3_canonical_user_id: description: the cannonical user id of the user who created the oai returned: always - type: string + type: str e_tag: description: The current version of the origin access identity created. returned: always - type: string + type: str location: description: The fully qualified URI of the new origin access identity just created. returned: when initially created - type: string + type: str ''' diff --git a/lib/ansible/modules/cloud/amazon/cloudtrail.py b/lib/ansible/modules/cloud/amazon/cloudtrail.py index c3349cabf1..932d2effce 100644 --- a/lib/ansible/modules/cloud/amazon/cloudtrail.py +++ b/lib/ansible/modules/cloud/amazon/cloudtrail.py @@ -173,12 +173,12 @@ trail: trail_arn: description: Full ARN of the CloudTrail resource returned: success - type: string + type: str sample: arn:aws:cloudtrail:us-east-1:123456789012:trail/default name: description: Name of the CloudTrail resource returned: success - type: string + type: str sample: default is_logging: description: Whether logging is turned on or paused for the Trail @@ -188,12 +188,12 @@ trail: s3_bucket_name: description: S3 bucket name where log files are delivered returned: success - type: string + type: str sample: myBucket s3_key_prefix: description: Key prefix in bucket where log files are delivered (if any) returned: success when present - type: string + type: str sample: myKeyPrefix log_file_validation_enabled: description: Whether log file validation is enabled on the trail @@ -218,32 +218,32 @@ trail: home_region: description: The home region where the trail was originally created and must be edited. returned: success - type: string + type: str sample: us-east-1 sns_topic_name: description: The SNS topic name where log delivery notifications are sent. returned: success when present - type: string + type: str sample: myTopic sns_topic_arn: description: Full ARN of the SNS topic where log delivery notifications are sent. returned: success when present - type: string + type: str sample: arn:aws:sns:us-east-1:123456789012:topic/myTopic cloud_watch_logs_log_group_arn: description: Full ARN of the CloudWatch Logs log group where events are delivered. returned: success when present - type: string + type: str sample: arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail/DefaultLogGroup:* cloud_watch_logs_role_arn: description: Full ARN of the IAM role that CloudTrail assumes to deliver events. returned: success when present - type: string + type: str sample: arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role kms_key_id: description: Full ARN of the KMS Key used to encrypt log files. returned: success when present - type: string + type: str sample: arn:aws:kms::123456789012:key/12345678-1234-1234-1234-123456789012 tags: description: hash/dictionary of tags applied to this resource diff --git a/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group.py b/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group.py index eccfc79659..69b6bfe84f 100644 --- a/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group.py +++ b/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group.py @@ -90,31 +90,31 @@ log_groups: log_group_name: description: The name of the log group. returned: always - type: string + type: str creation_time: description: The creation time of the log group. returned: always - type: integer + type: int retention_in_days: description: The number of days to retain the log events in the specified log group. returned: always - type: integer + type: int metric_filter_count: description: The number of metric filters. returned: always - type: integer + type: int arn: description: The Amazon Resource Name (ARN) of the log group. returned: always - type: string + type: str stored_bytes: description: The number of bytes stored. returned: always - type: string + type: str kms_key_id: description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. returned: always - type: string + type: str ''' import traceback diff --git a/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group_facts.py b/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group_facts.py index e16a33c996..a5c9dfb931 100644 --- a/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group_facts.py +++ b/lib/ansible/modules/cloud/amazon/cloudwatchlogs_log_group_facts.py @@ -43,31 +43,31 @@ log_groups: log_group_name: description: The name of the log group. returned: always - type: string + type: str creation_time: description: The creation time of the log group. returned: always - type: integer + type: int retention_in_days: description: The number of days to retain the log events in the specified log group. returned: always - type: integer + type: int metric_filter_count: description: The number of metric filters. returned: always - type: integer + type: int arn: description: The Amazon Resource Name (ARN) of the log group. returned: always - type: string + type: str stored_bytes: description: The number of bytes stored. returned: always - type: string + type: str kms_key_id: description: The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. returned: always - type: string + type: str ''' import traceback diff --git a/lib/ansible/modules/cloud/amazon/dynamodb_table.py b/lib/ansible/modules/cloud/amazon/dynamodb_table.py index 294b079d66..7e2dcbe04e 100644 --- a/lib/ansible/modules/cloud/amazon/dynamodb_table.py +++ b/lib/ansible/modules/cloud/amazon/dynamodb_table.py @@ -128,7 +128,7 @@ RETURN = ''' table_status: description: The current status of the table. returned: success - type: string + type: str sample: ACTIVE ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_ami.py b/lib/ansible/modules/cloud/amazon/ec2_ami.py index 69b87369d0..d2f18fe883 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_ami.py +++ b/lib/ansible/modules/cloud/amazon/ec2_ami.py @@ -215,7 +215,7 @@ RETURN = ''' architecture: description: architecture of image returned: when AMI is created or already exists - type: string + type: str sample: "x86_64" block_device_mapping: description: block device mapping associated with image @@ -233,22 +233,22 @@ block_device_mapping: creationDate: description: creation date of image returned: when AMI is created or already exists - type: string + type: str sample: "2015-10-15T22:43:44.000Z" description: description: description of image returned: when AMI is created or already exists - type: string + type: str sample: "nat-server" hypervisor: description: type of hypervisor returned: when AMI is created or already exists - type: string + type: str sample: "xen" image_id: description: id of the image returned: when AMI is created or already exists - type: string + type: str sample: "ami-1234abcd" is_public: description: whether image is public @@ -264,37 +264,37 @@ launch_permission: location: description: location of image returned: when AMI is created or already exists - type: string + type: str sample: "315210894379/nat-server" name: description: ami name of image returned: when AMI is created or already exists - type: string + type: str sample: "nat-server" ownerId: description: owner of image returned: when AMI is created or already exists - type: string + type: str sample: "435210894375" platform: description: platform of image returned: when AMI is created or already exists - type: string + type: str sample: null root_device_name: description: root device name of image returned: when AMI is created or already exists - type: string + type: str sample: "/dev/sda1" root_device_type: description: root device type of image returned: when AMI is created or already exists - type: string + type: str sample: "ebs" state: description: state of image returned: when AMI is created or already exists - type: string + type: str sample: "available" tags: description: a dictionary of tags assigned to image @@ -307,7 +307,7 @@ tags: virtualization_type: description: image virtualization type returned: when AMI is created or already exists - type: string + type: str sample: "hvm" snapshots_deleted: description: a list of snapshot ids deleted after deregistering image diff --git a/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py b/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py index e7268ea07e..d7e7673520 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py +++ b/lib/ansible/modules/cloud/amazon/ec2_ami_copy.py @@ -137,7 +137,7 @@ RETURN = ''' image_id: description: AMI ID of the copied AMI returned: always - type: string + type: str sample: ami-e689729e ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py b/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py index 3c773357d3..8cfa4d868a 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py @@ -79,7 +79,7 @@ images: architecture: description: The architecture of the image returned: always - type: string + type: str sample: x86_64 block_device_mappings: description: Any block device mapping entries @@ -89,7 +89,7 @@ images: device_name: description: The device name exposed to the instance returned: always - type: string + type: str sample: /dev/sda1 ebs: description: EBS volumes @@ -98,12 +98,12 @@ images: creation_date: description: The date and time the image was created returned: always - type: string + type: str sample: '2017-10-16T19:22:13.000Z' description: description: The description of the AMI returned: always - type: string + type: str sample: '' ena_support: description: whether enhanced networking with ENA is enabled @@ -113,22 +113,22 @@ images: hypervisor: description: The hypervisor type of the image returned: always - type: string + type: str sample: xen image_id: description: The ID of the AMI returned: always - type: string + type: str sample: ami-5b466623 image_location: description: The location of the AMI returned: always - type: string + type: str sample: 408466080000/Webapp image_type: description: The type of image returned: always - type: string + type: str sample: machine launch_permissions: description: launch permissions of the ami @@ -138,12 +138,12 @@ images: name: description: The name of the AMI that was provided during image creation returned: always - type: string + type: str sample: Webapp owner_id: description: The AWS account ID of the image owner returned: always - type: string + type: str sample: '408466080000' public: description: whether the image has public launch permissions @@ -153,22 +153,22 @@ images: root_device_name: description: The device name of the root device returned: always - type: string + type: str sample: /dev/sda1 root_device_type: description: The type of root device used by the AMI returned: always - type: string + type: str sample: ebs sriov_net_support: description: whether enhanced networking is enabled returned: always - type: string + type: str sample: simple state: description: The current state of the AMI returned: always - type: string + type: str sample: available tags: description: Any tags assigned to the image @@ -177,7 +177,7 @@ images: virtualization_type: description: The type of virtualization of the AMI returned: always - type: string + type: str sample: hvm ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py b/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py index dd3c321e71..f439c02c25 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_asg_facts.py @@ -81,7 +81,7 @@ RETURN = ''' auto_scaling_group_arn: description: The Amazon Resource Name of the ASG returned: success - type: string + type: str sample: "arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1" auto_scaling_group_name: description: Name of autoscaling group @@ -96,7 +96,7 @@ availability_zones: created_time: description: The date and time this ASG was created, in ISO 8601 format. returned: success - type: string + type: str sample: "2015-11-25T00:05:36.309Z" default_cooldown: description: The default cooldown time in seconds. @@ -162,7 +162,7 @@ min_size: new_instances_protected_from_scale_in: description: Whether or not new instances a protected from automatic scaling in. returned: success - type: boolean + type: bool sample: "false" placement_group: description: Placement group into which instances are launched, if any. diff --git a/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py b/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py index 1eb6baa5ba..c578cd783c 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py +++ b/lib/ansible/modules/cloud/amazon/ec2_customer_gateway.py @@ -90,32 +90,32 @@ gateway.customer_gateways: description: The Border Gateway Autonomous System Number. returned: when exists and gateway is available. sample: 65123 - type: string + type: str customer_gateway_id: description: gateway id assigned by amazon. returned: when exists and gateway is available. sample: cgw-cb6386a2 - type: string + type: str ip_address: description: ip address of your gateway device. returned: when exists and gateway is available. sample: 1.2.3.4 - type: string + type: str state: description: state of gateway. returned: when gateway exists and is available. state: available - type: string + type: str tags: description: any tags on the gateway. returned: when gateway exists and is available, and when tags exist. state: available - type: string + type: str type: description: encryption type. returned: when gateway exists and is available. sample: ipsec.1 - type: string + type: str ''' try: diff --git a/lib/ansible/modules/cloud/amazon/ec2_eip.py b/lib/ansible/modules/cloud/amazon/ec2_eip.py index 07cf3b6ecb..22b00645a0 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_eip.py +++ b/lib/ansible/modules/cloud/amazon/ec2_eip.py @@ -155,12 +155,12 @@ RETURN = ''' allocation_id: description: allocation_id of the elastic ip returned: on success - type: string + type: str sample: eipalloc-51aa3a6c public_ip: description: an elastic ip address returned: on success - type: string + type: str sample: 52.88.159.209 ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_eni.py b/lib/ansible/modules/cloud/amazon/ec2_eni.py index ae4771bd63..10eb7203d3 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_eni.py +++ b/lib/ansible/modules/cloud/amazon/ec2_eni.py @@ -205,7 +205,7 @@ interface: contains: description: description: interface description - type: string + type: str sample: Firewall network interface groups: description: list of security groups @@ -213,19 +213,19 @@ interface: sample: [ { "sg-f8a8a9da": "default" } ] id: description: network interface id - type: string + type: str sample: "eni-1d889198" mac_address: description: interface's physical address - type: string + type: str sample: "00:00:5E:00:53:23" owner_id: description: aws account id - type: string + type: str sample: 812381371 private_ip_address: description: primary ip address of this interface - type: string + type: str sample: 10.20.30.40 private_ip_addresses: description: list of all private ip addresses associated to this interface @@ -233,19 +233,19 @@ interface: sample: [ { "primary_address": true, "private_ip_address": "10.20.30.40" } ] source_dest_check: description: value of source/dest check flag - type: boolean + type: bool sample: True status: description: network interface status - type: string + type: str sample: "pending" subnet_id: description: which vpc subnet the interface is bound - type: string + type: str sample: subnet-b0a0393c vpc_id: description: which vpc this network interface is bound - type: string + type: str sample: vpc-9a9a9da ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py b/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py index 9ecc431f77..02ef1cf040 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_eni_facts.py @@ -83,12 +83,12 @@ network_interfaces: availability_zone: description: Availability zone of ENI returned: always - type: string + type: str sample: "us-east-1b" description: description: Description text for ENI returned: always - type: string + type: str sample: "My favourite network interface" groups: description: List of attached security groups @@ -103,12 +103,12 @@ network_interfaces: id: description: The id of the ENI (alias for network_interface_id) returned: always - type: string + type: str sample: "eni-392fsdf" interface_type: description: Type of the network interface returned: always - type: string + type: str sample: "interface" ipv6_addresses: description: List of IPv6 addresses for this interface @@ -118,27 +118,27 @@ network_interfaces: mac_address: description: MAC address of the network interface returned: always - type: string + type: str sample: "0a:f8:10:2f:ab:a1" network_interface_id: description: The id of the ENI returned: always - type: string + type: str sample: "eni-392fsdf" owner_id: description: AWS account id of the owner of the ENI returned: always - type: string + type: str sample: "4415120123456" private_dns_name: description: Private DNS name for the ENI returned: always - type: string + type: str sample: "ip-172-16-1-180.ec2.internal" private_ip_address: description: Private IP address for the ENI returned: always - type: string + type: str sample: "172.16.1.180" private_ip_addresses: description: List of private IP addresses attached to the ENI @@ -148,7 +148,7 @@ network_interfaces: requester_id: description: The ID of the entity that launched the ENI returned: always - type: string + type: str sample: "AIDAIONYVJQNIAZFT3ABC" requester_managed: description: Indicates whether the network interface is being managed by an AWS service. @@ -163,12 +163,12 @@ network_interfaces: status: description: Indicates if the network interface is attached to an instance or not returned: always - type: string + type: str sample: "in-use" subnet_id: description: Subnet ID the ENI is in returned: always - type: string + type: str sample: "subnet-7bbf01234" tag_set: description: Dictionary of tags added to the ENI @@ -178,7 +178,7 @@ network_interfaces: vpc_id: description: ID of the VPC the network interface it part of returned: always - type: string + type: str sample: "vpc-b3f1f123" ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_group.py b/lib/ansible/modules/cloud/amazon/ec2_group.py index 27ba2bb75d..2d6f8e9540 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_group.py +++ b/lib/ansible/modules/cloud/amazon/ec2_group.py @@ -237,17 +237,17 @@ RETURN = ''' group_name: description: Security group name sample: My Security Group - type: string + type: str returned: on create/update group_id: description: Security group id sample: sg-abcd1234 - type: string + type: str returned: on create/update description: description: Description of security group sample: My Security Group - type: string + type: str returned: on create/update tags: description: Tags associated with the security group @@ -259,7 +259,7 @@ tags: vpc_id: description: ID of VPC to which the security group belongs sample: vpc-abcd1234 - type: string + type: str returned: on create/update ip_permissions: description: Inbound rules associated with the security group. diff --git a/lib/ansible/modules/cloud/amazon/ec2_instance.py b/lib/ansible/modules/cloud/amazon/ec2_instance.py index 22010b2a32..0b23f4cd50 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_instance.py +++ b/lib/ansible/modules/cloud/amazon/ec2_instance.py @@ -312,7 +312,7 @@ instances: architecture: description: The architecture of the image returned: always - type: string + type: str sample: x86_64 block_device_mappings: description: Any block device mapping entries for the instance. @@ -322,7 +322,7 @@ instances: device_name: description: The device name exposed to the instance (for example, /dev/sdh or xvdh). returned: always - type: string + type: str sample: /dev/sdh ebs: description: Parameters used to automatically set up EBS volumes when the instance is launched. @@ -332,7 +332,7 @@ instances: attach_time: description: The time stamp when the attachment initiated. returned: always - type: string + type: str sample: "2017-03-23T22:51:24+00:00" delete_on_termination: description: Indicates whether the volume is deleted on instance termination. @@ -342,17 +342,17 @@ instances: status: description: The attachment state. returned: always - type: string + type: str sample: attached volume_id: description: The ID of the EBS volume returned: always - type: string + type: str sample: vol-12345678 client_token: description: The idempotency token you provided when you launched the instance, if applicable. returned: always - type: string + type: str sample: mytoken ebs_optimized: description: Indicates whether the instance is optimized for EBS I/O. @@ -362,7 +362,7 @@ instances: hypervisor: description: The hypervisor type of the instance. returned: always - type: string + type: str sample: xen iam_instance_profile: description: The IAM instance profile associated with the instance, if applicable. @@ -372,37 +372,37 @@ instances: arn: description: The Amazon Resource Name (ARN) of the instance profile. returned: always - type: string + type: str sample: "arn:aws:iam::000012345678:instance-profile/myprofile" id: description: The ID of the instance profile returned: always - type: string + type: str sample: JFJ397FDG400FG9FD1N image_id: description: The ID of the AMI used to launch the instance. returned: always - type: string + type: str sample: ami-0011223344 instance_id: description: The ID of the instance. returned: always - type: string + type: str sample: i-012345678 instance_type: description: The instance type size of the running instance. returned: always - type: string + type: str sample: t2.micro key_name: description: The name of the key pair, if this instance was launched with an associated key pair. returned: always - type: string + type: str sample: my-key launch_time: description: The time the instance was launched. returned: always - type: string + type: str sample: "2017-03-23T22:51:24+00:00" monitoring: description: The monitoring for the instance. @@ -412,7 +412,7 @@ instances: state: description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. returned: always - type: string + type: str sample: disabled network_interfaces: description: One or more network interfaces for the instance. @@ -427,17 +427,17 @@ instances: ip_owner_id: description: The ID of the owner of the Elastic IP address. returned: always - type: string + type: str sample: amazon public_dns_name: description: The public DNS name. returned: always - type: string + type: str sample: "" public_ip: description: The public IP address or Elastic IP address bound to the network interface. returned: always - type: string + type: str sample: 1.2.3.4 attachment: description: The network interface attachment. @@ -447,12 +447,12 @@ instances: attach_time: description: The time stamp when the attachment initiated. returned: always - type: string + type: str sample: "2017-03-23T22:51:24+00:00" attachment_id: description: The ID of the network interface attachment. returned: always - type: string + type: str sample: eni-attach-3aff3f delete_on_termination: description: Indicates whether the network interface is deleted when the instance is terminated. @@ -467,12 +467,12 @@ instances: status: description: The attachment state. returned: always - type: string + type: str sample: attached description: description: The description. returned: always - type: string + type: str sample: My interface groups: description: One or more security groups. @@ -482,12 +482,12 @@ instances: - group_id: description: The ID of the security group. returned: always - type: string + type: str sample: sg-abcdef12 group_name: description: The name of the security group. returned: always - type: string + type: str sample: mygroup ipv6_addresses: description: One or more IPv6 addresses associated with the network interface. @@ -497,27 +497,27 @@ instances: - ipv6_address: description: The IPv6 address. returned: always - type: string + type: str sample: "2001:0db8:85a3:0000:0000:8a2e:0370:7334" mac_address: description: The MAC address. returned: always - type: string + type: str sample: "00:11:22:33:44:55" network_interface_id: description: The ID of the network interface. returned: always - type: string + type: str sample: eni-01234567 owner_id: description: The AWS account ID of the owner of the network interface. returned: always - type: string + type: str sample: 01234567890 private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always - type: string + type: str sample: 10.0.0.1 private_ip_addresses: description: The private IPv4 addresses associated with the network interface. @@ -532,17 +532,17 @@ instances: ip_owner_id: description: The ID of the owner of the Elastic IP address. returned: always - type: string + type: str sample: amazon public_dns_name: description: The public DNS name. returned: always - type: string + type: str sample: "" public_ip: description: The public IP address or Elastic IP address bound to the network interface. returned: always - type: string + type: str sample: 1.2.3.4 primary: description: Indicates whether this IPv4 address is the primary private IP address of the network interface. @@ -552,7 +552,7 @@ instances: private_ip_address: description: The private IPv4 address of the network interface. returned: always - type: string + type: str sample: 10.0.0.1 source_dest_check: description: Indicates whether source/destination checking is enabled. @@ -562,17 +562,17 @@ instances: status: description: The status of the network interface. returned: always - type: string + type: str sample: in-use subnet_id: description: The ID of the subnet for the network interface. returned: always - type: string + type: str sample: subnet-0123456 vpc_id: description: The ID of the VPC for the network interface. returned: always - type: string + type: str sample: vpc-0123456 placement: description: The location where the instance launched, if applicable. @@ -582,27 +582,27 @@ instances: availability_zone: description: The Availability Zone of the instance. returned: always - type: string + type: str sample: ap-southeast-2a group_name: description: The name of the placement group the instance is in (for cluster compute instances). returned: always - type: string + type: str sample: "" tenancy: description: The tenancy of the instance (if the instance is running in a VPC). returned: always - type: string + type: str sample: default private_dns_name: description: The private DNS name. returned: always - type: string + type: str sample: ip-10-0-0-1.ap-southeast-2.compute.internal private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always - type: string + type: str sample: 10.0.0.1 product_codes: description: One or more product codes. @@ -612,32 +612,32 @@ instances: - product_code_id: description: The product code. returned: always - type: string + type: str sample: aw0evgkw8ef3n2498gndfgasdfsd5cce product_code_type: description: The type of product code. returned: always - type: string + type: str sample: marketplace public_dns_name: description: The public DNS name assigned to the instance. returned: always - type: string + type: str sample: public_ip_address: description: The public IPv4 address assigned to the instance returned: always - type: string + type: str sample: 52.0.0.1 root_device_name: description: The device name of the root device returned: always - type: string + type: str sample: /dev/sda1 root_device_type: description: The type of root device used by the AMI. returned: always - type: string + type: str sample: ebs security_groups: description: One or more security groups for the instance. @@ -647,12 +647,12 @@ instances: - group_id: description: The ID of the security group. returned: always - type: string + type: str sample: sg-0123456 - group_name: description: The name of the security group. returned: always - type: string + type: str sample: my-security-group network.source_dest_check: description: Indicates whether source/destination checking is enabled. @@ -672,17 +672,17 @@ instances: name: description: The name of the state. returned: always - type: string + type: str sample: running state_transition_reason: description: The reason for the most recent state transition. returned: always - type: string + type: str sample: subnet_id: description: The ID of the subnet in which the instance is running. returned: always - type: string + type: str sample: subnet-00abcdef tags: description: Any tags assigned to the instance. @@ -692,7 +692,7 @@ instances: virtualization_type: description: The type of virtualization of the AMI. returned: always - type: string + type: str sample: hvm vpc_id: description: The ID of the VPC the instance is in. diff --git a/lib/ansible/modules/cloud/amazon/ec2_instance_facts.py b/lib/ansible/modules/cloud/amazon/ec2_instance_facts.py index 864de8d7b5..f0528900e0 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_instance_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_instance_facts.py @@ -82,7 +82,7 @@ instances: architecture: description: The architecture of the image returned: always - type: string + type: str sample: x86_64 block_device_mappings: description: Any block device mapping entries for the instance. @@ -92,7 +92,7 @@ instances: device_name: description: The device name exposed to the instance (for example, /dev/sdh or xvdh). returned: always - type: string + type: str sample: /dev/sdh ebs: description: Parameters used to automatically set up EBS volumes when the instance is launched. @@ -102,7 +102,7 @@ instances: attach_time: description: The time stamp when the attachment initiated. returned: always - type: string + type: str sample: "2017-03-23T22:51:24+00:00" delete_on_termination: description: Indicates whether the volume is deleted on instance termination. @@ -112,12 +112,12 @@ instances: status: description: The attachment state. returned: always - type: string + type: str sample: attached volume_id: description: The ID of the EBS volume returned: always - type: string + type: str sample: vol-12345678 cpu_options: description: The CPU options set for the instance. @@ -137,7 +137,7 @@ instances: client_token: description: The idempotency token you provided when you launched the instance, if applicable. returned: always - type: string + type: str sample: mytoken ebs_optimized: description: Indicates whether the instance is optimized for EBS I/O. @@ -147,7 +147,7 @@ instances: hypervisor: description: The hypervisor type of the instance. returned: always - type: string + type: str sample: xen iam_instance_profile: description: The IAM instance profile associated with the instance, if applicable. @@ -157,37 +157,37 @@ instances: arn: description: The Amazon Resource Name (ARN) of the instance profile. returned: always - type: string + type: str sample: "arn:aws:iam::000012345678:instance-profile/myprofile" id: description: The ID of the instance profile returned: always - type: string + type: str sample: JFJ397FDG400FG9FD1N image_id: description: The ID of the AMI used to launch the instance. returned: always - type: string + type: str sample: ami-0011223344 instance_id: description: The ID of the instance. returned: always - type: string + type: str sample: i-012345678 instance_type: description: The instance type size of the running instance. returned: always - type: string + type: str sample: t2.micro key_name: description: The name of the key pair, if this instance was launched with an associated key pair. returned: always - type: string + type: str sample: my-key launch_time: description: The time the instance was launched. returned: always - type: string + type: str sample: "2017-03-23T22:51:24+00:00" monitoring: description: The monitoring for the instance. @@ -197,7 +197,7 @@ instances: state: description: Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. returned: always - type: string + type: str sample: disabled network_interfaces: description: One or more network interfaces for the instance. @@ -212,17 +212,17 @@ instances: ip_owner_id: description: The ID of the owner of the Elastic IP address. returned: always - type: string + type: str sample: amazon public_dns_name: description: The public DNS name. returned: always - type: string + type: str sample: "" public_ip: description: The public IP address or Elastic IP address bound to the network interface. returned: always - type: string + type: str sample: 1.2.3.4 attachment: description: The network interface attachment. @@ -232,12 +232,12 @@ instances: attach_time: description: The time stamp when the attachment initiated. returned: always - type: string + type: str sample: "2017-03-23T22:51:24+00:00" attachment_id: description: The ID of the network interface attachment. returned: always - type: string + type: str sample: eni-attach-3aff3f delete_on_termination: description: Indicates whether the network interface is deleted when the instance is terminated. @@ -252,12 +252,12 @@ instances: status: description: The attachment state. returned: always - type: string + type: str sample: attached description: description: The description. returned: always - type: string + type: str sample: My interface groups: description: One or more security groups. @@ -267,12 +267,12 @@ instances: - group_id: description: The ID of the security group. returned: always - type: string + type: str sample: sg-abcdef12 group_name: description: The name of the security group. returned: always - type: string + type: str sample: mygroup ipv6_addresses: description: One or more IPv6 addresses associated with the network interface. @@ -282,27 +282,27 @@ instances: - ipv6_address: description: The IPv6 address. returned: always - type: string + type: str sample: "2001:0db8:85a3:0000:0000:8a2e:0370:7334" mac_address: description: The MAC address. returned: always - type: string + type: str sample: "00:11:22:33:44:55" network_interface_id: description: The ID of the network interface. returned: always - type: string + type: str sample: eni-01234567 owner_id: description: The AWS account ID of the owner of the network interface. returned: always - type: string + type: str sample: 01234567890 private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always - type: string + type: str sample: 10.0.0.1 private_ip_addresses: description: The private IPv4 addresses associated with the network interface. @@ -317,17 +317,17 @@ instances: ip_owner_id: description: The ID of the owner of the Elastic IP address. returned: always - type: string + type: str sample: amazon public_dns_name: description: The public DNS name. returned: always - type: string + type: str sample: "" public_ip: description: The public IP address or Elastic IP address bound to the network interface. returned: always - type: string + type: str sample: 1.2.3.4 primary: description: Indicates whether this IPv4 address is the primary private IP address of the network interface. @@ -337,7 +337,7 @@ instances: private_ip_address: description: The private IPv4 address of the network interface. returned: always - type: string + type: str sample: 10.0.0.1 source_dest_check: description: Indicates whether source/destination checking is enabled. @@ -347,17 +347,17 @@ instances: status: description: The status of the network interface. returned: always - type: string + type: str sample: in-use subnet_id: description: The ID of the subnet for the network interface. returned: always - type: string + type: str sample: subnet-0123456 vpc_id: description: The ID of the VPC for the network interface. returned: always - type: string + type: str sample: vpc-0123456 placement: description: The location where the instance launched, if applicable. @@ -367,27 +367,27 @@ instances: availability_zone: description: The Availability Zone of the instance. returned: always - type: string + type: str sample: ap-southeast-2a group_name: description: The name of the placement group the instance is in (for cluster compute instances). returned: always - type: string + type: str sample: "" tenancy: description: The tenancy of the instance (if the instance is running in a VPC). returned: always - type: string + type: str sample: default private_dns_name: description: The private DNS name. returned: always - type: string + type: str sample: ip-10-0-0-1.ap-southeast-2.compute.internal private_ip_address: description: The IPv4 address of the network interface within the subnet. returned: always - type: string + type: str sample: 10.0.0.1 product_codes: description: One or more product codes. @@ -397,32 +397,32 @@ instances: - product_code_id: description: The product code. returned: always - type: string + type: str sample: aw0evgkw8ef3n2498gndfgasdfsd5cce product_code_type: description: The type of product code. returned: always - type: string + type: str sample: marketplace public_dns_name: description: The public DNS name assigned to the instance. returned: always - type: string + type: str sample: public_ip_address: description: The public IPv4 address assigned to the instance returned: always - type: string + type: str sample: 52.0.0.1 root_device_name: description: The device name of the root device returned: always - type: string + type: str sample: /dev/sda1 root_device_type: description: The type of root device used by the AMI. returned: always - type: string + type: str sample: ebs security_groups: description: One or more security groups for the instance. @@ -432,12 +432,12 @@ instances: - group_id: description: The ID of the security group. returned: always - type: string + type: str sample: sg-0123456 - group_name: description: The name of the security group. returned: always - type: string + type: str sample: my-security-group source_dest_check: description: Indicates whether source/destination checking is enabled. @@ -457,17 +457,17 @@ instances: name: description: The name of the state. returned: always - type: string + type: str sample: running state_transition_reason: description: The reason for the most recent state transition. returned: always - type: string + type: str sample: subnet_id: description: The ID of the subnet in which the instance is running. returned: always - type: string + type: str sample: subnet-00abcdef tags: description: Any tags assigned to the instance. @@ -477,7 +477,7 @@ instances: virtualization_type: description: The type of virtualization of the AMI. returned: always - type: string + type: str sample: hvm vpc_id: description: The ID of the VPC the instance is in. diff --git a/lib/ansible/modules/cloud/amazon/ec2_key.py b/lib/ansible/modules/cloud/amazon/ec2_key.py index d493757f74..3969035427 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_key.py +++ b/lib/ansible/modules/cloud/amazon/ec2_key.py @@ -104,7 +104,7 @@ changed: msg: description: short message describing the action taken returned: always - type: string + type: str sample: key pair created key: description: details of the keypair (this is set to null when state is absent) @@ -114,17 +114,17 @@ key: fingerprint: description: fingerprint of the key returned: when state is present - type: string + type: str sample: 'b0:22:49:61:d9:44:9d:0c:7e:ac:8a:32:93:21:6c:e8:fb:59:62:43' name: description: name of the keypair returned: when state is present - type: string + type: str sample: my_keypair private_key: description: private key of a newly created keypair returned: when a new keypair is created by AWS (key_material is not provided) - type: string + type: str sample: '-----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKC... -----END RSA PRIVATE KEY-----' diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc.py b/lib/ansible/modules/cloud/amazon/ec2_lc.py index 68fe6ee278..24eb1259e9 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_lc.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc.py @@ -188,7 +188,7 @@ RETURN = ''' arn: description: The Amazon Resource Name of the launch configuration. returned: when I(state=present) - type: string + type: str sample: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name changed: description: Whether the state of the launch configuration has changed. @@ -198,22 +198,22 @@ changed: created_time: description: The creation date and time for the launch configuration. returned: when I(state=present) - type: string + type: str sample: '2017-11-03 23:46:44.841000' image_id: description: The ID of the Amazon Machine Image used by the launch configuration. returned: when I(state=present) - type: string + type: str sample: ami-9be6f38c instance_type: description: The instance type for the instances. returned: when I(state=present) - type: string + type: str sample: t1.micro name: description: The name of the launch configuration. returned: when I(state=present) - type: string + type: str sample: launch_config_name result: description: The specification details for the launch configuration. @@ -223,7 +223,7 @@ result: PlacementTenancy: description: The tenancy of the instances, either default or dedicated. returned: when I(state=present) - type: string + type: str sample: default associate_public_ip_address: description: (EC2-VPC) Indicates whether to assign a public IP address to each instance. @@ -238,7 +238,7 @@ result: device_name: description: The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). returned: when I(state=present) - type: string + type: str sample: /dev/sda1 ebs: description: The information about the Amazon EBS volume. @@ -253,7 +253,7 @@ result: volume_size: description: The volume size, in GiB. returned: when I(state=present) - type: string + type: str sample: '100' virtual_name: description: The name of the virtual device (for example, ephemeral0). @@ -273,7 +273,7 @@ result: created_time: description: The creation date and time for the launch configuration. returned: when I(state=present) - type: string + type: str sample: '2017-11-03 23:46:44.841000' delete_on_termination: description: Indicates whether the volume is deleted on instance termination. @@ -288,7 +288,7 @@ result: image_id: description: The ID of the Amazon Machine Image used by the launch configuration. returned: when I(state=present) - type: string + type: str sample: ami-9be6f38c instance_monitoring: description: Indicates whether instances in this group are launched with detailed (true) or basic (false) monitoring. @@ -298,12 +298,12 @@ result: instance_profile_name: description: The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. returned: when I(state=present) - type: string + type: str sample: null instance_type: description: The instance type for the instances. returned: when I(state=present) - type: string + type: str sample: t1.micro iops: description: The number of I/O operations per second (IOPS) to provision for the volume. @@ -313,32 +313,32 @@ result: kernel_id: description: The ID of the kernel associated with the AMI. returned: when I(state=present) - type: string + type: str sample: '' key_name: description: The name of the key pair. returned: when I(state=present) - type: string + type: str sample: testkey launch_configuration_arn: description: The Amazon Resource Name (ARN) of the launch configuration. returned: when I(state=present) - type: string + type: str sample: arn:aws:autoscaling:us-east-1:148830907657:launchConfiguration:888d9b58-d93a-40c4-90cf-759197a2621a:launchConfigurationName/launch_config_name member: description: "" returned: when I(state=present) - type: string + type: str sample: "\n " name: description: The name of the launch configuration. returned: when I(state=present) - type: string + type: str sample: launch_config_name ramdisk_id: description: The ID of the RAM disk associated with the AMI. returned: when I(state=present) - type: string + type: str sample: '' security_groups: description: The security groups to associate with the instances. @@ -359,7 +359,7 @@ result: user_data: description: The user data available to the instances. returned: when I(state=present) - type: string + type: str sample: '' volume_type: description: The volume type (one of standard, io1, gp2). diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py b/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py index 62303b0320..e3fcd86477 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc_facts.py @@ -79,12 +79,12 @@ block_device_mapping: }]" classic_link_vpc_security_groups: description: IDs of one or more security groups for the VPC specified in classic_link_vpc_id - type: string + type: str returned: always sample: created_time: description: The creation date and time for the launch configuration - type: string + type: str returned: always sample: "2016-05-27T13:47:44.216000+00:00" ebs_optimized: @@ -94,7 +94,7 @@ ebs_optimized: sample: true, image_id: description: ID of the Amazon Machine Image (AMI) - type: string + type: str returned: always sample: "ami-12345678" instance_monitoring: @@ -106,32 +106,32 @@ instance_monitoring: }" instance_type: description: Instance type - type: string + type: str returned: always sample: "t2.micro" kernel_id: description: ID of the kernel associated with the AMI - type: string + type: str returned: always sample: key_name: description: Name of the key pair - type: string + type: str returned: always sample: "user_app" launch_configuration_arn: description: Amazon Resource Name (ARN) of the launch configuration - type: string + type: str returned: always sample: "arn:aws:autoscaling:us-east-1:666612345678:launchConfiguration:ba785e3a-dd42-6f02-4585-ea1a2b458b3d:launchConfigurationName/lc-app" launch_configuration_name: description: Name of the launch configuration - type: string + type: str returned: always sample: "lc-app" ramdisk_id: description: ID of the RAM disk associated with the AMI - type: string + type: str returned: always sample: security_groups: @@ -143,7 +143,7 @@ security_groups: ]" user_data: description: User data available - type: string + type: str returned: always sample: ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_lc_find.py b/lib/ansible/modules/cloud/amazon/ec2_lc_find.py index 4349589af7..c4dcdc9ea4 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_lc_find.py +++ b/lib/ansible/modules/cloud/amazon/ec2_lc_find.py @@ -66,42 +66,42 @@ RETURN = ''' image_id: description: AMI id returned: when Launch Configuration was found - type: string + type: str sample: "ami-0d75df7e" user_data: description: User data used to start instance returned: when Launch Configuration was found - type: string + type: str sample: "ZXhwb3J0IENMT1VE" name: description: Name of the Launch Configuration returned: when Launch Configuration was found - type: string + type: str sample: "myapp-v123" arn: description: Name of the AMI returned: when Launch Configuration was found - type: string + type: str sample: "arn:aws:autoscaling:eu-west-1:12345:launchConfiguration:d82f050e-e315:launchConfigurationName/yourproject" instance_type: description: Type of ec2 instance returned: when Launch Configuration was found - type: string + type: str sample: "t2.small" created_time: description: When it was created returned: when Launch Configuration was found - type: string + type: str sample: "2016-06-29T14:59:22.222000+00:00" ebs_optimized: description: Launch Configuration EBS optimized property returned: when Launch Configuration was found - type: boolean + type: bool sample: False instance_monitoring: description: Launch Configuration instance monitoring property returned: when Launch Configuration was found - type: string + type: str sample: {"Enabled": false} classic_link_vpc_security_groups: description: Launch Configuration classic link vpc security groups property @@ -116,7 +116,7 @@ block_device_mappings: keyname: description: Launch Configuration ssh key returned: when Launch Configuration was found - type: string + type: str sample: mykey security_groups: description: Launch Configuration security groups @@ -126,17 +126,17 @@ security_groups: kernel_id: description: Launch Configuration kernel to use returned: when Launch Configuration was found - type: string + type: str sample: '' ram_disk_id: description: Launch Configuration ram disk property returned: when Launch Configuration was found - type: string + type: str sample: '' associate_public_address: description: Assign public address or not returned: when Launch Configuration was found - type: boolean + type: bool sample: True ... ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py b/lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py index 5093ccc3d5..70994088a8 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_metadata_facts.py @@ -45,60 +45,60 @@ ansible_facts: contains: ansible_ec2_ami_id: description: The AMI ID used to launch the instance. - type: string + type: str sample: "ami-XXXXXXXX" ansible_ec2_ami_launch_index: description: - If you started more than one instance at the same time, this value indicates the order in which the instance was launched. The value of the first instance launched is 0. - type: string + type: str sample: "0" ansible_ec2_ami_manifest_path: description: - The path to the AMI manifest file in Amazon S3. If you used an Amazon EBS-backed AMI to launch the instance, the returned result is unknown. - type: string + type: str sample: "(unknown)" ansible_ec2_ancestor_ami_ids: description: - The AMI IDs of any instances that were rebundled to create this AMI. This value will only exist if the AMI manifest file contained an ancestor-amis key. - type: string + type: str sample: "(unknown)" ansible_ec2_block_device_mapping_ami: description: The virtual device that contains the root/boot file system. - type: string + type: str sample: "/dev/sda1" ansible_ec2_block_device_mapping_ebsN: description: - The virtual devices associated with Amazon EBS volumes, if any are present. Amazon EBS volumes are only available in metadata if they were present at launch time or when the instance was last started. The N indicates the index of the Amazon EBS volume (such as ebs1 or ebs2). - type: string + type: str sample: "/dev/xvdb" ansible_ec2_block_device_mapping_ephemeralN: description: The virtual devices associated with ephemeral devices, if any are present. The N indicates the index of the ephemeral volume. - type: string + type: str sample: "/dev/xvdc" ansible_ec2_block_device_mapping_root: description: - The virtual devices or partitions associated with the root devices, or partitions on the virtual device, where the root (/ or C) file system is associated with the given instance. - type: string + type: str sample: "/dev/sda1" ansible_ec2_block_device_mapping_swap: description: The virtual devices associated with swap. Not always present. - type: string + type: str sample: "/dev/sda2" ansible_ec2_fws_instance_monitoring: description: "Value showing whether the customer has enabled detailed one-minute monitoring in CloudWatch." - type: string + type: str sample: "enabled" ansible_ec2_hostname: description: - The private IPv4 DNS hostname of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). - type: string + type: str sample: "ip-10-0-0-1.ec2.internal" ansible_ec2_iam_info: description: @@ -108,310 +108,310 @@ ansible_facts: sample: "" ansible_ec2_iam_info_instanceprofilearn: description: The IAM instance profile ARN. - type: string + type: str sample: "arn:aws:iam::<account id>:instance-profile/<role name>" ansible_ec2_iam_info_instanceprofileid: description: IAM instance profile ID. - type: string + type: str sample: "" ansible_ec2_iam_info_lastupdated: description: IAM info last updated time. - type: string + type: str sample: "2017-05-12T02:42:27Z" ansible_ec2_iam_instance_profile_role: description: IAM instance role. - type: string + type: str sample: "role_name" ansible_ec2_iam_security_credentials_<role name>: description: - If there is an IAM role associated with the instance, role-name is the name of the role, and role-name contains the temporary security credentials associated with the role. Otherwise, not present. - type: string + type: str sample: "" ansible_ec2_iam_security_credentials_<role name>_accesskeyid: description: IAM role access key ID. - type: string + type: str sample: "" ansible_ec2_iam_security_credentials_<role name>_code: description: IAM code. - type: string + type: str sample: "Success" ansible_ec2_iam_security_credentials_<role name>_expiration: description: IAM role credentials expiration time. - type: string + type: str sample: "2017-05-12T09:11:41Z" ansible_ec2_iam_security_credentials_<role name>_lastupdated: description: IAM role last updated time. - type: string + type: str sample: "2017-05-12T02:40:44Z" ansible_ec2_iam_security_credentials_<role name>_secretaccesskey: description: IAM role secret access key. - type: string + type: str sample: "" ansible_ec2_iam_security_credentials_<role name>_token: description: IAM role token. - type: string + type: str sample: "" ansible_ec2_iam_security_credentials_<role name>_type: description: IAM role type. - type: string + type: str sample: "AWS-HMAC" ansible_ec2_instance_action: description: Notifies the instance that it should reboot in preparation for bundling. - type: string + type: str sample: "none" ansible_ec2_instance_id: description: The ID of this instance. - type: string + type: str sample: "i-XXXXXXXXXXXXXXXXX" ansible_ec2_instance_identity_document: description: JSON containing instance attributes, such as instance-id, private IP address, etc. - type: string + type: str sample: "" ansible_ec2_instance_identity_document_accountid: description: "" - type: string + type: str sample: "012345678901" ansible_ec2_instance_identity_document_architecture: description: Instance system architecture. - type: string + type: str sample: "x86_64" ansible_ec2_instance_identity_document_availabilityzone: description: The Availability Zone in which the instance launched. - type: string + type: str sample: "us-east-1a" ansible_ec2_instance_identity_document_billingproducts: description: Billing products for this instance. - type: string + type: str sample: "" ansible_ec2_instance_identity_document_devpayproductcodes: description: Product codes for the launched AMI. - type: string + type: str sample: "" ansible_ec2_instance_identity_document_imageid: description: The AMI ID used to launch the instance. - type: string + type: str sample: "ami-01234567" ansible_ec2_instance_identity_document_instanceid: description: The ID of this instance. - type: string + type: str sample: "i-0123456789abcdef0" ansible_ec2_instance_identity_document_instancetype: description: The type of instance. - type: string + type: str sample: "m4.large" ansible_ec2_instance_identity_document_kernelid: description: The ID of the kernel launched with this instance, if applicable. - type: string + type: str sample: "" ansible_ec2_instance_identity_document_pendingtime: description: The instance pending time. - type: string + type: str sample: "2017-05-11T20:51:20Z" ansible_ec2_instance_identity_document_privateip: description: - The private IPv4 address of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). - type: string + type: str sample: "10.0.0.1" ansible_ec2_instance_identity_document_ramdiskid: description: The ID of the RAM disk specified at launch time, if applicable. - type: string + type: str sample: "" ansible_ec2_instance_identity_document_region: description: The Region in which the instance launched. - type: string + type: str sample: "us-east-1" ansible_ec2_instance_identity_document_version: description: Identity document version. - type: string + type: str sample: "2010-08-31" ansible_ec2_instance_identity_pkcs7: description: Used to verify the document's authenticity and content against the signature. - type: string + type: str sample: "" ansible_ec2_instance_identity_rsa2048: description: Used to verify the document's authenticity and content against the signature. - type: string + type: str sample: "" ansible_ec2_instance_identity_signature: description: Data that can be used by other parties to verify its origin and authenticity. - type: string + type: str sample: "" ansible_ec2_instance_type: description: The type of instance. - type: string + type: str sample: "m4.large" ansible_ec2_local_hostname: description: - The private IPv4 DNS hostname of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). - type: string + type: str sample: "ip-10-0-0-1.ec2.internal" ansible_ec2_local_ipv4: description: - The private IPv4 address of the instance. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). - type: string + type: str sample: "10.0.0.1" ansible_ec2_mac: description: - The instance's media access control (MAC) address. In cases where multiple network interfaces are present, this refers to the eth0 device (the device for which the device number is 0). - type: string + type: str sample: "00:11:22:33:44:55" ansible_ec2_metrics_vhostmd: description: Metrics. - type: string + type: str sample: "" ansible_ec2_network_interfaces_macs_<mac address>_device_number: description: - The unique device number associated with that interface. The device number corresponds to the device name; for example, a device-number of 2 is for the eth2 device. This category corresponds to the DeviceIndex and device-index fields that are used by the Amazon EC2 API and the EC2 commands for the AWS CLI. - type: string + type: str sample: "0" ansible_ec2_network_interfaces_macs_<mac address>_interface_id: description: The elastic network interface ID. - type: string + type: str sample: "eni-12345678" ansible_ec2_network_interfaces_macs_<mac address>_ipv4_associations_<ip address>: description: The private IPv4 addresses that are associated with each public-ip address and assigned to that interface. - type: string + type: str sample: "" ansible_ec2_network_interfaces_macs_<mac address>_ipv6s: description: The IPv6 addresses associated with the interface. Returned only for instances launched into a VPC. - type: string + type: str sample: "" ansible_ec2_network_interfaces_macs_<mac address>_local_hostname: description: The interface's local hostname. - type: string + type: str sample: "" ansible_ec2_network_interfaces_macs_<mac address>_local_ipv4s: description: The private IPv4 addresses associated with the interface. - type: string + type: str sample: "" ansible_ec2_network_interfaces_macs_<mac address>_mac: description: The instance's MAC address. - type: string + type: str sample: "00:11:22:33:44:55" ansible_ec2_network_interfaces_macs_<mac address>_owner_id: description: - The ID of the owner of the network interface. In multiple-interface environments, an interface can be attached by a third party, such as Elastic Load Balancing. Traffic on an interface is always billed to the interface owner. - type: string + type: str sample: "01234567890" ansible_ec2_network_interfaces_macs_<mac address>_public_hostname: description: - The interface's public DNS (IPv4). If the instance is in a VPC, this category is only returned if the enableDnsHostnames attribute is set to true. - type: string + type: str sample: "ec2-1-2-3-4.compute-1.amazonaws.com" ansible_ec2_network_interfaces_macs_<mac address>_public_ipv4s: description: The Elastic IP addresses associated with the interface. There may be multiple IPv4 addresses on an instance. - type: string + type: str sample: "1.2.3.4" ansible_ec2_network_interfaces_macs_<mac address>_security_group_ids: description: The IDs of the security groups to which the network interface belongs. Returned only for instances launched into a VPC. - type: string + type: str sample: "sg-01234567,sg-01234568" ansible_ec2_network_interfaces_macs_<mac address>_security_groups: description: Security groups to which the network interface belongs. Returned only for instances launched into a VPC. - type: string + type: str sample: "secgroup1,secgroup2" ansible_ec2_network_interfaces_macs_<mac address>_subnet_id: description: The ID of the subnet in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "subnet-01234567" ansible_ec2_network_interfaces_macs_<mac address>_subnet_ipv4_cidr_block: description: The IPv4 CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "10.0.1.0/24" ansible_ec2_network_interfaces_macs_<mac address>_subnet_ipv6_cidr_blocks: description: The IPv6 CIDR block of the subnet in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "" ansible_ec2_network_interfaces_macs_<mac address>_vpc_id: description: The ID of the VPC in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "vpc-0123456" ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv4_cidr_block: description: The IPv4 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "10.0.0.0/16" ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv4_cidr_blocks: description: The IPv4 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "10.0.0.0/16" ansible_ec2_network_interfaces_macs_<mac address>_vpc_ipv6_cidr_blocks: description: The IPv6 CIDR block of the VPC in which the interface resides. Returned only for instances launched into a VPC. - type: string + type: str sample: "" ansible_ec2_placement_availability_zone: description: The Availability Zone in which the instance launched. - type: string + type: str sample: "us-east-1a" ansible_ec2_placement_region: description: The Region in which the instance launched. - type: string + type: str sample: "us-east-1" ansible_ec2_product_codes: description: Product codes associated with the instance, if any. - type: string + type: str sample: "aw0evgkw8e5c1q413zgy5pjce" ansible_ec2_profile: description: EC2 instance hardware profile. - type: string + type: str sample: "default-hvm" ansible_ec2_public_hostname: description: - The instance's public DNS. If the instance is in a VPC, this category is only returned if the enableDnsHostnames attribute is set to true. - type: string + type: str sample: "ec2-1-2-3-4.compute-1.amazonaws.com" ansible_ec2_public_ipv4: description: The public IPv4 address. If an Elastic IP address is associated with the instance, the value returned is the Elastic IP address. - type: string + type: str sample: "1.2.3.4" ansible_ec2_public_key: description: Public key. Only available if supplied at instance launch time. - type: string + type: str sample: "" ansible_ec2_ramdisk_id: description: The ID of the RAM disk specified at launch time, if applicable. - type: string + type: str sample: "" ansible_ec2_reservation_id: description: The ID of the reservation. - type: string + type: str sample: "r-0123456789abcdef0" ansible_ec2_security_groups: description: - The names of the security groups applied to the instance. After launch, you can only change the security groups of instances running in a VPC. Such changes are reflected here and in network/interfaces/macs/mac/security-groups. - type: string + type: str sample: "securitygroup1,securitygroup2" ansible_ec2_services_domain: description: The domain for AWS resources for the region; for example, amazonaws.com for us-east-1. - type: string + type: str sample: "amazonaws.com" ansible_ec2_services_partition: description: - The partition that the resource is in. For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn. - type: string + type: str sample: "aws" ansible_ec2_spot_termination_time: description: - The approximate time, in UTC, that the operating system for your Spot instance will receive the shutdown signal. This item is present and contains a time value only if the Spot instance has been marked for termination by Amazon EC2. The termination-time item is not set to a time if you terminated the Spot instance yourself. - type: string + type: str sample: "2015-01-05T18:02:00Z" ansible_ec2_user_data: description: The instance user data. - type: string + type: str sample: "#!/bin/bash" ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_placement_group.py b/lib/ansible/modules/cloud/amazon/ec2_placement_group.py index 7686c558ac..b3cfaa20e2 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_placement_group.py +++ b/lib/ansible/modules/cloud/amazon/ec2_placement_group.py @@ -73,15 +73,15 @@ placement_group: contains: name: description: PG name - type: string + type: str sample: my-cluster state: description: PG state - type: string + type: str sample: "available" strategy: description: PG strategy - type: string + type: str sample: "cluster" ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py b/lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py index 1fbad84350..8bfff195b7 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_placement_group_facts.py @@ -55,15 +55,15 @@ placement_groups: contains: name: description: PG name - type: string + type: str sample: my-cluster state: description: PG state - type: string + type: str sample: "available" strategy: description: PG strategy - type: string + type: str sample: "cluster" ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py b/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py index fd9a5d2ff5..e55b59f353 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py +++ b/lib/ansible/modules/cloud/amazon/ec2_snapshot_copy.py @@ -102,7 +102,7 @@ RETURN = ''' snapshot_id: description: snapshot id of the newly created snapshot returned: when snapshot copy is successful - type: string + type: str sample: "snap-e9095e8c" ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py b/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py index 228b5a42c1..187a52088c 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_snapshot_facts.py @@ -95,44 +95,44 @@ EXAMPLES = ''' RETURN = ''' snapshot_id: description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. - type: string + type: str returned: always sample: snap-01234567 volume_id: description: The ID of the volume that was used to create the snapshot. - type: string + type: str returned: always sample: vol-01234567 state: description: The snapshot state (completed, pending or error). - type: string + type: str returned: always sample: completed state_message: description: Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. - type: string + type: str returned: always sample: start_time: description: The time stamp when the snapshot was initiated. - type: string + type: str returned: always sample: "2015-02-12T02:14:02+00:00" progress: description: The progress of the snapshot, as a percentage. - type: string + type: str returned: always sample: "100%" owner_id: description: The AWS account ID of the EBS snapshot owner. - type: string + type: str returned: always sample: "099720109477" description: description: The description for the snapshot. - type: string + type: str returned: always sample: "My important backup" volume_size: @@ -142,7 +142,7 @@ volume_size: sample: 8 owner_alias: description: The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot. - type: string + type: str returned: always sample: "033440102211" tags: @@ -152,19 +152,19 @@ tags: sample: "{ 'my_tag_key': 'my_tag_value' }" encrypted: description: Indicates whether the snapshot is encrypted. - type: boolean + type: bool returned: always sample: "True" kms_key_id: description: The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to \ protect the volume encryption key for the parent volume. - type: string + type: str returned: always sample: "74c9742a-a1b2-45cb-b3fe-abcdef123456" data_encryption_key_id: description: The data encryption key identifier for the snapshot. This value is a unique identifier that \ corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. - type: string + type: str returned: always sample: "arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456" diff --git a/lib/ansible/modules/cloud/amazon/ec2_vol.py b/lib/ansible/modules/cloud/amazon/ec2_vol.py index 459a8875b7..d147fea54c 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vol.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vol.py @@ -183,22 +183,22 @@ RETURN = ''' device: description: device name of attached volume returned: when success - type: string + type: str sample: "/def/sdf" volume_id: description: the id of volume returned: when success - type: string + type: str sample: "vol-35b333d9" volume_type: description: the volume type returned: when success - type: string + type: str sample: "standard" volume: description: a dictionary containing detailed attributes of the volume returned: when success - type: string + type: str sample: { "attachment_set": { "attach_time": "2015-10-23T00:22:29.000Z", diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py index e155aa73c7..75b6673ac9 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_dhcp_option.py @@ -114,7 +114,7 @@ new_options: domain-name: "my.example.com" dhcp_options_id: description: The aws resource id of the primary DCHP options set created, found or removed - type: string + type: str returned: when available changed: description: Whether the dhcp options were changed diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_egress_igw.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_egress_igw.py index 61dcf42d84..6558a9a71b 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_egress_igw.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_egress_igw.py @@ -46,12 +46,12 @@ RETURN = ''' gateway_id: description: The ID of the Egress Only Internet Gateway or Null. returned: always - type: string + type: str sample: eigw-0e00cf111ba5bc11e vpc_id: description: The ID of the VPC to attach or detach gateway from. returned: always - type: string + type: str sample: vpc-012345678 ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py index d0473d9f4c..9a142257aa 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl.py @@ -139,7 +139,7 @@ RETURN = ''' task: description: The result of the create, or delete action. returned: success - type: dictionary + type: dict ''' try: diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py index e80f67168e..38af498767 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_facts.py @@ -68,15 +68,15 @@ nacls: nacl_id: description: The ID of the Network Access Control List. returned: always - type: string + type: str vpc_id: description: The ID of the VPC that the NACL is attached to. returned: always - type: string + type: str is_default: description: True if the NACL is the default for its VPC. returned: always - type: boolean + type: bool tags: description: A dict of tags associated with the NACL. returned: always diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py index 546a226826..cee5e69019 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_nat_gateway.py @@ -156,32 +156,32 @@ RETURN = ''' create_time: description: The ISO 8601 date time format in UTC. returned: In all cases. - type: string + type: str sample: "2016-03-05T05:19:20.282000+00:00'" nat_gateway_id: description: id of the VPC NAT Gateway returned: In all cases. - type: string + type: str sample: "nat-0d1e3a878585988f8" subnet_id: description: id of the Subnet returned: In all cases. - type: string + type: str sample: "subnet-12345" state: description: The current state of the NAT Gateway. returned: In all cases. - type: string + type: str sample: "available" vpc_id: description: id of the VPC. returned: In all cases. - type: string + type: str sample: "vpc-12345" nat_gateway_addresses: description: List of dictionairies containing the public_ip, network_interface_id, private_ip, and allocation_id. returned: In all cases. - type: string + type: str sample: [ { 'public_ip': '52.52.52.52', diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_net.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_net.py index 07619078f8..f06738ac0f 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_net.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_net.py @@ -102,7 +102,7 @@ vpc: cidr_block: description: The CIDR of the VPC returned: always - type: string + type: str sample: 10.0.0.0/16 cidr_block_association_set: description: IPv4 CIDR blocks associated with the VPC @@ -126,17 +126,17 @@ vpc: dhcp_options_id: description: the id of the DHCP options assocaited with this VPC returned: always - type: string + type: str sample: dopt-0fb8bd6b id: description: VPC resource id returned: always - type: string + type: str sample: vpc-c2e00da5 instance_tenancy: description: indicates whether VPC uses default or dedicated tenancy returned: always - type: string + type: str sample: default is_default: description: indicates whether this is the default VPC @@ -146,7 +146,7 @@ vpc: state: description: state of the VPC returned: always - type: string + type: str sample: available tags: description: tags attached to the VPC, includes name @@ -156,7 +156,7 @@ vpc: Name: description: name tag for the VPC returned: always - type: string + type: str sample: pk_vpc4 ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_net_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_net_facts.py index 516d9e7c0c..8aabbae519 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_net_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_net_facts.py @@ -69,15 +69,15 @@ vpcs: id: description: The ID of the VPC (for backwards compatibility). returned: always - type: string + type: str vpc_id: description: The ID of the VPC . returned: always - type: string + type: str state: description: The state of the VPC. returned: always - type: string + type: str tags: description: A dict of tags associated with the VPC. returned: always @@ -85,31 +85,31 @@ vpcs: instance_tenancy: description: The instance tenancy setting for the VPC. returned: always - type: string + type: str is_default: description: True if this is the default VPC for account. returned: always - type: boolean + type: bool cidr_block: description: The IPv4 CIDR block assigned to the VPC. returned: always - type: string + type: str classic_link_dns_supported: description: True/False depending on attribute setting for classic link DNS support. returned: always - type: boolean + type: bool classic_link_enabled: description: True/False depending on if classic link support is enabled. returned: always - type: boolean + type: bool enable_dns_hostnames: description: True/False depending on attribute setting for DNS hostnames support. returned: always - type: boolean + type: bool enable_dns_support: description: True/False depending on attribute setting for DNS support. returned: always - type: boolean + type: bool ipv6_cidr_block_association_set: description: An array of IPv6 cidr block association set information. returned: always @@ -118,11 +118,11 @@ vpcs: association_id: description: The association ID returned: always - type: string + type: str ipv6_cidr_block: description: The IPv6 CIDR block that is associated with the VPC. returned: always - type: string + type: str ipv6_cidr_block_state: description: A hash/dict that contains a single item. The state of the cidr block association. returned: always @@ -131,7 +131,7 @@ vpcs: state: description: The CIDR block association state. returned: always - type: string + type: str ''' import traceback diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py index 6840b4fcb4..58fabe6c3a 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_peer.py @@ -211,7 +211,7 @@ RETURN = ''' task: description: The result of the create, accept, reject or delete action. returned: success - type: dictionary + type: dict ''' try: diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py index cb2a387f33..9a49af2e68 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_route_table.py @@ -143,22 +143,22 @@ route_table: route_table_association_id: description: ID of association between route table and subnet returned: always - type: string + type: str sample: rtbassoc-ab47cfc3 route_table_id: description: ID of the route table returned: always - type: string + type: str sample: rtb-bf779ed7 subnet_id: description: ID of the subnet returned: always - type: string + type: str sample: subnet-82055af9 id: description: ID of the route table (same as route_table_id for backwards compatibility) returned: always - type: string + type: str sample: rtb-bf779ed7 propagating_vgws: description: List of Virtual Private Gateways propagating routes @@ -168,7 +168,7 @@ route_table: route_table_id: description: ID of the route table returned: always - type: string + type: str sample: rtb-bf779ed7 routes: description: List of routes in the route table @@ -178,37 +178,37 @@ route_table: destination_cidr_block: description: CIDR block of destination returned: always - type: string + type: str sample: 10.228.228.0/22 gateway_id: description: ID of the gateway returned: when gateway is local or internet gateway - type: string + type: str sample: local instance_id: description: ID of a NAT instance returned: when the route is via an EC2 instance - type: string + type: str sample: i-abcd123456789 instance_owner_id: description: AWS account owning the NAT instance returned: when the route is via an EC2 instance - type: string + type: str sample: 123456789012 nat_gateway_id: description: ID of the NAT gateway returned: when the route is via a NAT gateway - type: string + type: str sample: local origin: description: mechanism through which the route is in the table returned: always - type: string + type: str sample: CreateRouteTable state: description: state of the route returned: always - type: string + type: str sample: active tags: description: Tags applied to the route table @@ -220,7 +220,7 @@ route_table: vpc_id: description: ID for the VPC in which the route lives returned: always - type: string + type: str sample: vpc-6e2d2407 ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py index 2c5e0d4ebf..5da769d763 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet.py @@ -123,27 +123,27 @@ subnet: id: description: Subnet resource id returned: I(state=present) - type: string + type: str sample: subnet-b883b2c4 cidr_block: description: The IPv4 CIDR of the Subnet returned: I(state=present) - type: string + type: str sample: "10.0.0.0/16" ipv6_cidr_block: description: The IPv6 CIDR block actively associated with the Subnet returned: I(state=present) - type: string + type: str sample: "2001:db8:0:102::/64" availability_zone: description: Availability zone of the Subnet returned: I(state=present) - type: string + type: str sample: us-east-1a state: description: state of the Subnet returned: I(state=present) - type: string + type: str sample: available tags: description: tags attached to the Subnet, includes name @@ -153,32 +153,32 @@ subnet: map_public_ip_on_launch: description: whether public IP is auto-assigned to new instances returned: I(state=present) - type: boolean + type: bool sample: false assign_ipv6_address_on_creation: description: whether IPv6 address is auto-assigned to new instances returned: I(state=present) - type: boolean + type: bool sample: false vpc_id: description: the id of the VPC where this Subnet exists returned: I(state=present) - type: string + type: str sample: vpc-67236184 available_ip_address_count: description: number of available IPv4 addresses returned: I(state=present) - type: string + type: str sample: 251 default_for_az: description: indicates whether this is the default Subnet for this Availability Zone returned: I(state=present) - type: boolean + type: bool sample: false ipv6_association_id: description: The IPv6 association ID for the currently associated CIDR returned: I(state=present) - type: string + type: str sample: subnet-cidr-assoc-b85c74d2 ipv6_cidr_block_association_set: description: An array of IPv6 cidr block association set information. @@ -188,11 +188,11 @@ subnet: association_id: description: The association ID returned: always - type: string + type: str ipv6_cidr_block: description: The IPv6 CIDR block that is associated with the subnet. returned: always - type: string + type: str ipv6_cidr_block_state: description: A hash/dict that contains a single item. The state of the cidr block association. returned: always @@ -201,7 +201,7 @@ subnet: state: description: The CIDR block association state. returned: always - type: string + type: str ''' diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet_facts.py index 8f27c4db89..33bde161e6 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_subnet_facts.py @@ -91,19 +91,19 @@ subnets: subnet_id: description: The ID of the Subnet. returned: always - type: string + type: str id: description: The ID of the Subnet (for backwards compatibility). returned: always - type: string + type: str vpc_id: description: The ID of the VPC . returned: always - type: string + type: str state: description: The state of the subnet. returned: always - type: string + type: str tags: description: A dict of tags associated with the Subnet. returned: always @@ -111,27 +111,27 @@ subnets: map_public_ip_on_launch: description: True/False depending on attribute setting for public IP mapping. returned: always - type: boolean + type: bool default_for_az: description: True if this is the default subnet for AZ. returned: always - type: boolean + type: bool cidr_block: description: The IPv4 CIDR block assigned to the subnet. returned: always - type: string + type: str available_ip_address_count: description: Count of available IPs in subnet. returned: always - type: string + type: str availability_zone: description: The availability zone where the subnet exists. returned: always - type: string + type: str assign_ipv6_address_on_creation: description: True/False depending on attribute setting for IPv6 address assignment. returned: always - type: boolean + type: bool ipv6_cidr_block_association_set: description: An array of IPv6 cidr block association set information. returned: always @@ -140,11 +140,11 @@ subnets: association_id: description: The association ID returned: always - type: string + type: str ipv6_cidr_block: description: The IPv6 CIDR block that is associated with the subnet. returned: always - type: string + type: str ipv6_cidr_block_state: description: A hash/dict that contains a single item. The state of the cidr block association. returned: always @@ -153,7 +153,7 @@ subnets: state: description: The CIDR block association state. returned: always - type: string + type: str ''' import traceback diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py index 4941b3a564..7b18cf7777 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vgw.py @@ -104,7 +104,7 @@ RETURN = ''' result: description: The result of the create, or delete action. returned: success - type: dictionary + type: dict ''' import time diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py index 43b9ca97ee..393b6424b1 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn.py @@ -230,7 +230,7 @@ routes: }] state: description: The status of the VPN connection. - type: string + type: str returned: I(state=present) sample: state: available diff --git a/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_facts.py b/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_facts.py index 4a9a4c9b47..1f9512fd86 100644 --- a/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_facts.py +++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_facts.py @@ -59,16 +59,16 @@ vpn_connections: category: description: The category of the VPN connection. returned: always - type: string + type: str sample: VPN customer_gatway_configuration: description: The configuration information for the VPN connection's customer gateway (in the native XML format). returned: always - type: string + type: str customer_gateway_id: description: The ID of the customer gateway at your end of the VPN connection. returned: always - type: string + type: str sample: cgw-17a53c37 options: description: The VPN connection options. @@ -85,17 +85,17 @@ vpn_connections: destination_cidr_block: description: The CIDR block associated with the local subnet of the customer data center. returned: always - type: string + type: str sample: 10.0.0.0/16 state: description: The current state of the static route. returned: always - type: string + type: str sample: available state: description: The current state of the VPN connection. returned: always - type: string + type: str sample: available tags: description: Any tags assigned to the VPN connection. @@ -107,7 +107,7 @@ vpn_connections: type: description: The type of VPN connection. returned: always - type: string + type: str sample: ipsec.1 vgw_telemetry: description: Information about the VPN tunnel. @@ -127,27 +127,27 @@ vpn_connections: outside_ip_address: description: The Internet-routable IP address of the virtual private gateway's outside interface. returned: always - type: string + type: str sample: 13.127.79.191 status: description: The status of the VPN tunnel. returned: always - type: string + type: str sample: DOWN status_message: description: If an error occurs, a description of the error. returned: always - type: string + type: str sample: IPSEC IS DOWN vpn_connection_id: description: The ID of the VPN connection. returned: always - type: string + type: str sample: vpn-f700d5c0 vpn_gateway_id: description: The ID of the virtual private gateway at the AWS side of the VPN connection. returned: always - type: string + type: str sample: vgw-cbe56bfb ''' diff --git a/lib/ansible/modules/cloud/amazon/ecs_attribute.py b/lib/ansible/modules/cloud/amazon/ecs_attribute.py index 3723e7b596..12f716c06f 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_attribute.py +++ b/lib/ansible/modules/cloud/amazon/ecs_attribute.py @@ -88,21 +88,21 @@ attributes: contains: cluster: description: cluster name - type: string + type: str ec2_instance_id: description: ec2 instance id of ecs container instance - type: string + type: str attributes: description: list of attributes type: list of complex contains: name: description: name of the attribute - type: string + type: str value: description: value of the attribute returned: if present - type: string + type: str ''' try: diff --git a/lib/ansible/modules/cloud/amazon/ecs_cluster.py b/lib/ansible/modules/cloud/amazon/ecs_cluster.py index 9681178f58..5327fd480e 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_cluster.py +++ b/lib/ansible/modules/cloud/amazon/ecs_cluster.py @@ -75,12 +75,12 @@ activeServicesCount: type: int clusterArn: description: the ARN of the cluster just created - type: string + type: str returned: 0 if a new cluster sample: arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok clusterName: description: name of the cluster just created (should match the input argument) - type: string + type: str returned: always sample: test-cluster-mfshcdok pendingTasksCount: @@ -98,7 +98,7 @@ runningTasksCount: status: description: the status of the new cluster returned: always - type: string + type: str sample: ACTIVE ''' import time diff --git a/lib/ansible/modules/cloud/amazon/ecs_ecr.py b/lib/ansible/modules/cloud/amazon/ecs_ecr.py index a5247d18ac..f0610cf9e0 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_ecr.py +++ b/lib/ansible/modules/cloud/amazon/ecs_ecr.py @@ -99,15 +99,15 @@ EXAMPLES = ''' RETURN = ''' state: - type: string + type: str description: The asserted state of the repository (present, absent) returned: always created: - type: boolean + type: bool description: If true, the repository was created returned: always name: - type: string + type: str description: The name of the repository returned: "when state == 'absent'" repository: diff --git a/lib/ansible/modules/cloud/amazon/ecs_service.py b/lib/ansible/modules/cloud/amazon/ecs_service.py index 2fbee91917..c9116bab32 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_service.py +++ b/lib/ansible/modules/cloud/amazon/ecs_service.py @@ -199,7 +199,7 @@ service: clusterArn: description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service. returned: always - type: string + type: str desiredCount: description: The desired number of instantiations of the task definition to keep running on the service. returned: always @@ -212,11 +212,11 @@ service: loadBalancerName: description: the name returned: always - type: string + type: str containerName: description: The name of the container to associate with the load balancer. returned: always - type: string + type: str containerPort: description: The port on the container to associate with the load balancer. returned: always @@ -234,19 +234,19 @@ service: of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service . returned: always - type: string + type: str serviceName: description: A user-generated string used to identify the service returned: always - type: string + type: str status: description: The valid values are ACTIVE, DRAINING, or INACTIVE. returned: always - type: string + type: str taskDefinition: description: The ARN of a task definition to use for tasks in the service. returned: always - type: string + type: str deployments: description: list of service deployments returned: always @@ -276,12 +276,12 @@ service: type: description: The type of constraint. Valid values are distinctInstance and memberOf. returned: always - type: string + type: str expression: description: A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. returned: always - type: string + type: str placementStrategy: description: List of placement strategy objects returned: always @@ -290,13 +290,13 @@ service: type: description: The type of placement strategy. Valid values are random, spread and binpack. returned: always - type: string + type: str field: description: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are CPU and MEMORY. returned: always - type: string + type: str ansible_facts: description: Facts about deleted service. returned: when deleting a service diff --git a/lib/ansible/modules/cloud/amazon/ecs_service_facts.py b/lib/ansible/modules/cloud/amazon/ecs_service_facts.py index 7bc3d402b7..ad889d3213 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_service_facts.py +++ b/lib/ansible/modules/cloud/amazon/ecs_service_facts.py @@ -72,7 +72,7 @@ services: clusterArn: description: The Amazon Resource Name (ARN) of the of the cluster that hosts the service. returned: always - type: string + type: str desiredCount: description: The desired number of instantiations of the task definition to keep running on the service. returned: always @@ -85,11 +85,11 @@ services: loadBalancerName: description: the name returned: always - type: string + type: str containerName: description: The name of the container to associate with the load balancer. returned: always - type: string + type: str containerPort: description: The port on the container to associate with the load balancer. returned: always @@ -105,19 +105,19 @@ services: serviceArn: description: The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service . returned: always - type: string + type: str serviceName: description: A user-generated string used to identify the service returned: always - type: string + type: str status: description: The valid values are ACTIVE, DRAINING, or INACTIVE. returned: always - type: string + type: str taskDefinition: description: The ARN of a task definition to use for tasks in the service. returned: always - type: string + type: str deployments: description: list of service deployments returned: always diff --git a/lib/ansible/modules/cloud/amazon/ecs_task.py b/lib/ansible/modules/cloud/amazon/ecs_task.py index cb212a4301..5d930b811e 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_task.py +++ b/lib/ansible/modules/cloud/amazon/ecs_task.py @@ -111,19 +111,19 @@ task: taskArn: description: The Amazon Resource Name (ARN) that identifies the task. returned: always - type: string + type: str clusterArn: description: The Amazon Resource Name (ARN) of the of the cluster that hosts the task. returned: only when details is true - type: string + type: str taskDefinitionArn: description: The Amazon Resource Name (ARN) of the task definition. returned: only when details is true - type: string + type: str containerInstanceArn: description: The Amazon Resource Name (ARN) of the container running the task. returned: only when details is true - type: string + type: str overrides: description: The container overrides set for this task. returned: only when details is true @@ -131,11 +131,11 @@ task: lastStatus: description: The last recorded status of the task. returned: only when details is true - type: string + type: str desiredStatus: description: The desired status of the task. returned: only when details is true - type: string + type: str containers: description: The container details. returned: only when details is true @@ -143,23 +143,23 @@ task: startedBy: description: The used who started the task. returned: only when details is true - type: string + type: str stoppedReason: description: The reason why the task was stopped. returned: only when details is true - type: string + type: str createdAt: description: The timestamp of when the task was created. returned: only when details is true - type: string + type: str startedAt: description: The timestamp of when the task was started. returned: only when details is true - type: string + type: str stoppedAt: description: The timestamp of when the task was stopped. returned: only when details is true - type: string + type: str ''' from ansible.module_utils.aws.core import AnsibleAWSModule diff --git a/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py b/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py index 6aaf68bdbd..f08ceb8037 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py +++ b/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py @@ -51,11 +51,11 @@ container_definitions: name: description: The name of a container. returned: always - type: string + type: str image: description: The image used to start a container. returned: always - type: string + type: str cpu: description: The number of cpu units reserved for the container. returned: always @@ -67,7 +67,7 @@ container_definitions: links: description: Links to other containers. returned: when present - type: string + type: str portMappings: description: The list of port mappings for the container. returned: always @@ -84,7 +84,7 @@ container_definitions: protocol: description: The protocol used for the port mapping. returned: when present - type: string + type: str essential: description: Whether this is an essential container or not. returned: always @@ -92,11 +92,11 @@ container_definitions: entryPoint: description: The entry point that is passed to the container. returned: when present - type: string + type: str command: description: The command that is passed to the container. returned: when present - type: string + type: str environment: description: The environment variables to pass to a container. returned: always @@ -105,11 +105,11 @@ container_definitions: name: description: The name of the environment variable. returned: when present - type: string + type: str value: description: The value of the environment variable. returned: when present - type: string + type: str mountPoints: description: The mount points for data volumes in your container. returned: always @@ -118,11 +118,11 @@ container_definitions: sourceVolume: description: The name of the volume to mount. returned: when present - type: string + type: str containerPath: description: The path on the container to mount the host volume at. returned: when present - type: string + type: str readOnly: description: If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. @@ -136,7 +136,7 @@ container_definitions: sourceContainer: description: The name of another container within the same task definition to mount volumes from. returned: when present - type: string + type: str readOnly: description: If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. @@ -145,15 +145,15 @@ container_definitions: hostname: description: The hostname to use for your container. returned: when present - type: string + type: str user: description: The user name to use inside the container. returned: when present - type: string + type: str workingDirectory: description: The working directory in which to run commands inside the container. returned: when present - type: string + type: str disableNetworking: description: When this parameter is true, networking is disabled within the container. returned: when present @@ -170,11 +170,11 @@ container_definitions: dnsServers: description: A list of DNS servers that are presented to the container. returned: when present - type: string + type: str dnsSearchDomains: description: A list of DNS search domains that are presented to the container. returned: when present - type: string + type: str extraHosts: description: A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. returned: when present @@ -183,19 +183,19 @@ container_definitions: hostname: description: The hostname to use in the /etc/hosts entry. returned: when present - type: string + type: str ipAddress: description: The IP address to use in the /etc/hosts entry. returned: when present - type: string + type: str dockerSecurityOptions: description: A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. returned: when present - type: string + type: str dockerLabels: description: A key/value map of labels to add to the container. returned: when present - type: string + type: str ulimits: description: A list of ulimits to set in the container. returned: when present @@ -204,7 +204,7 @@ container_definitions: name: description: The type of the ulimit . returned: when present - type: string + type: str softLimit: description: The soft limit for the ulimit type. returned: when present @@ -216,28 +216,28 @@ container_definitions: logConfiguration: description: The log configuration specification for the container. returned: when present - type: string + type: str options: description: The configuration options to send to the log driver. returned: when present - type: string + type: str family: description: The family of your task definition, used as the definition name returned: always - type: string + type: str task_definition_arn: description: ARN of the task definition returned: always - type: string + type: str task_role_arn: description: The ARN of the IAM role that containers in this task can assume returned: when role is set - type: string + type: str network_mode: description: Network mode for the containers returned: always - type: string + type: str revision: description: Revision number that was queried returned: always @@ -250,7 +250,7 @@ volumes: name: description: The name of the volume. returned: when present - type: string + type: str host: description: The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. @@ -259,11 +259,11 @@ volumes: source_path: description: The path on the host container instance that is presented to the container. returned: when present - type: string + type: str status: description: The status of the task definition returned: always - type: string + type: str requires_attributes: description: The container instance attributes required by your task returned: when present @@ -272,19 +272,19 @@ requires_attributes: name: description: The name of the attribute. returned: when present - type: string + type: str value: description: The value of the attribute. returned: when present - type: string + type: str targetType: description: The type of the target with which to attach the attribute. returned: when present - type: string + type: str targetId: description: The ID of the target. returned: when present - type: string + type: str placement_constraints: description: A list of placement constraint objects to use for tasks returned: always @@ -293,11 +293,11 @@ placement_constraints: type: description: The type of constraint. returned: when present - type: string + type: str expression: description: A cluster query language expression to apply to the constraint. returned: when present - type: string + type: str ''' from ansible.module_utils.aws.core import AnsibleAWSModule diff --git a/lib/ansible/modules/cloud/amazon/efs.py b/lib/ansible/modules/cloud/amazon/efs.py index 7b750410fa..38314dd82d 100644 --- a/lib/ansible/modules/cloud/amazon/efs.py +++ b/lib/ansible/modules/cloud/amazon/efs.py @@ -130,32 +130,32 @@ RETURN = ''' creation_time: description: timestamp of creation date returned: always - type: string + type: str sample: "2015-11-16 07:30:57-05:00" creation_token: description: EFS creation token returned: always - type: string + type: str sample: "console-88609e04-9a0e-4a2e-912c-feaa99509961" file_system_id: description: ID of the file system returned: always - type: string + type: str sample: "fs-xxxxxxxx" life_cycle_state: description: state of the EFS file system returned: always - type: string + type: str sample: "creating, available, deleting, deleted" mount_point: description: url of file system with leading dot from the time when AWS EFS required to add a region suffix to the address returned: always - type: string + type: str sample: ".fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/" filesystem_address: description: url of file system valid for use with mount returned: always - type: string + type: str sample: "fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/" mount_targets: description: list of mount targets @@ -180,7 +180,7 @@ mount_targets: name: description: name of the file system returned: always - type: string + type: str sample: "my-efs" number_of_mount_targets: description: the number of targets mounted @@ -190,7 +190,7 @@ number_of_mount_targets: owner_id: description: AWS account ID of EFS owner returned: always - type: string + type: str sample: "XXXXXXXXXXXX" size_in_bytes: description: size of the file system in bytes as of a timestamp @@ -204,7 +204,7 @@ size_in_bytes: performance_mode: description: performance mode of the file system returned: always - type: string + type: str sample: "generalPurpose" tags: description: tags on the efs instance diff --git a/lib/ansible/modules/cloud/amazon/elasticache_facts.py b/lib/ansible/modules/cloud/amazon/elasticache_facts.py index 45d5e5fa39..389ee6e222 100644 --- a/lib/ansible/modules/cloud/amazon/elasticache_facts.py +++ b/lib/ansible/modules/cloud/amazon/elasticache_facts.py @@ -47,22 +47,22 @@ elasticache_clusters: cache_cluster_create_time: description: Date and time cluster was created returned: always - type: string + type: str sample: '2017-09-15T05:43:46.038000+00:00' cache_cluster_id: description: ID of the cache cluster returned: always - type: string + type: str sample: abcd-1234-001 cache_cluster_status: description: Status of Elasticache cluster returned: always - type: string + type: str sample: available cache_node_type: description: Instance type of Elasticache nodes returned: always - type: string + type: str sample: cache.t2.micro cache_nodes: description: List of Elasticache nodes in the cluster @@ -72,22 +72,22 @@ elasticache_clusters: cache_node_create_time: description: Date and time node was created returned: always - type: string + type: str sample: '2017-09-15T05:43:46.038000+00:00' cache_node_id: description: ID of the cache node returned: always - type: string + type: str sample: '0001' cache_node_status: description: Status of the cache node returned: always - type: string + type: str sample: available customer_availability_zone: description: Availability Zone in which the cache node was created returned: always - type: string + type: str sample: ap-southeast-2b endpoint: description: Connection details for the cache node @@ -97,7 +97,7 @@ elasticache_clusters: address: description: URL of the cache node endpoint returned: always - type: string + type: str sample: abcd-1234-001.bgiz2p.0001.apse2.cache.amazonaws.com port: description: Port of the cache node endpoint @@ -107,7 +107,7 @@ elasticache_clusters: parameter_grou_status: description: Status of the Cache Parameter Group returned: always - type: string + type: str sample: in-sync cache_parameter_group: description: Contents of the Cache Parameter GGroup @@ -122,12 +122,12 @@ elasticache_clusters: cache_parameter_group_name: description: Name of the cache parameter group returned: always - type: string + type: str sample: default.redis3.2 parameter_apply_status: description: Status of parameter updates returned: always - type: string + type: str sample: in-sync cache_security_groups: description: Security Groups used by the cache @@ -138,22 +138,22 @@ elasticache_clusters: cache_subnet_group_name: description: Elasticache Subnet Group used by the cache returned: always - type: string + type: str sample: abcd-subnet-group client_download_landing_page: description: URL of client download web page returned: always - type: string + type: str sample: 'https://console.aws.amazon.com/elasticache/home#client-download:' engine: description: Engine used by elasticache returned: always - type: string + type: str sample: redis engine_version: description: Version of elasticache engine returned: always - type: string + type: str sample: 3.2.4 notification_configuration: description: Configuration of notifications @@ -163,12 +163,12 @@ elasticache_clusters: topic_arn: description: ARN of notification destination topic returned: if notifications are enabled - type: string + type: str sample: arn:aws:sns:*:123456789012:my_topic topic_name: description: Name of notification destination topic returned: if notifications are enabled - type: string + type: str sample: MyTopic num_cache_nodes: description: Number of Cache Nodes @@ -183,17 +183,17 @@ elasticache_clusters: preferred_availability_zone: description: Preferred Availability Zone returned: always - type: string + type: str sample: ap-southeast-2b preferred_maintenance_window: description: Time slot for preferred maintenance window returned: always - type: string + type: str sample: sat:12:00-sat:13:00 replication_group_id: description: Replication Group Id returned: always - type: string + type: str sample: replication-001 security_groups: description: List of Security Groups associated with Elasticache @@ -203,12 +203,12 @@ elasticache_clusters: security_group_id: description: Security Group ID returned: always - type: string + type: str sample: sg-abcd1234 status: description: Status of Security Group returned: always - type: string + type: str sample: active tags: description: Tags applied to the elasticache cluster diff --git a/lib/ansible/modules/cloud/amazon/elb_application_lb.py b/lib/ansible/modules/cloud/amazon/elb_application_lb.py index 9060daa496..07c925f5fe 100644 --- a/lib/ansible/modules/cloud/amazon/elb_application_lb.py +++ b/lib/ansible/modules/cloud/amazon/elb_application_lb.py @@ -221,17 +221,17 @@ RETURN = ''' access_logs_s3_bucket: description: The name of the S3 bucket for the access logs. returned: when state is present - type: string + type: str sample: mys3bucket access_logs_s3_enabled: description: Indicates whether access logs stored in Amazon S3 are enabled. returned: when state is present - type: string + type: str sample: true access_logs_s3_prefix: description: The prefix for the location in the S3 bucket. returned: when state is present - type: string + type: str sample: /my/logs availability_zones: description: The Availability Zones for the load balancer. @@ -241,32 +241,32 @@ availability_zones: canonical_hosted_zone_id: description: The ID of the Amazon Route 53 hosted zone associated with the load balancer. returned: when state is present - type: string + type: str sample: ABCDEF12345678 created_time: description: The date and time the load balancer was created. returned: when state is present - type: string + type: str sample: "2015-02-12T02:14:02+00:00" deletion_protection_enabled: description: Indicates whether deletion protection is enabled. returned: when state is present - type: string + type: str sample: true dns_name: description: The public DNS name of the load balancer. returned: when state is present - type: string + type: str sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com idle_timeout_timeout_seconds: description: The idle timeout value, in seconds. returned: when state is present - type: string + type: str sample: 60 ip_address_type: description: The type of IP addresses used by the subnets for the load balancer. returned: when state is present - type: string + type: str sample: ipv4 listeners: description: Information about the listeners. @@ -276,12 +276,12 @@ listeners: listener_arn: description: The Amazon Resource Name (ARN) of the listener. returned: when state is present - type: string + type: str sample: "" load_balancer_arn: description: The Amazon Resource Name (ARN) of the load balancer. returned: when state is present - type: string + type: str sample: "" port: description: The port on which the load balancer is listening. @@ -291,7 +291,7 @@ listeners: protocol: description: The protocol for connections from clients to the load balancer. returned: when state is present - type: string + type: str sample: HTTPS certificates: description: The SSL server certificate. @@ -301,47 +301,47 @@ listeners: certificate_arn: description: The Amazon Resource Name (ARN) of the certificate. returned: when state is present - type: string + type: str sample: "" ssl_policy: description: The security policy that defines which ciphers and protocols are supported. returned: when state is present - type: string + type: str sample: "" default_actions: description: The default actions for the listener. returned: when state is present - type: string + type: str contains: type: description: The type of action. returned: when state is present - type: string + type: str sample: "" target_group_arn: description: The Amazon Resource Name (ARN) of the target group. returned: when state is present - type: string + type: str sample: "" load_balancer_arn: description: The Amazon Resource Name (ARN) of the load balancer. returned: when state is present - type: string + type: str sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 load_balancer_name: description: The name of the load balancer. returned: when state is present - type: string + type: str sample: my-elb routing_http2_enabled: description: Indicates whether HTTP/2 is enabled. returned: when state is present - type: string + type: str sample: true scheme: description: Internet-facing or internal load balancer. returned: when state is present - type: string + type: str sample: internal security_groups: description: The IDs of the security groups for the load balancer. @@ -363,12 +363,12 @@ tags: type: description: The type of load balancer. returned: when state is present - type: string + type: str sample: application vpc_id: description: The ID of the VPC for the load balancer. returned: when state is present - type: string + type: str sample: vpc-0011223344 ''' diff --git a/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py b/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py index 0fc7be0b0d..38a90ff769 100644 --- a/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py +++ b/lib/ansible/modules/cloud/amazon/elb_application_lb_facts.py @@ -68,17 +68,17 @@ load_balancers: access_logs_s3_bucket: description: The name of the S3 bucket for the access logs. returned: when status is present - type: string + type: str sample: mys3bucket access_logs_s3_enabled: description: Indicates whether access logs stored in Amazon S3 are enabled. returned: when status is present - type: string + type: str sample: true access_logs_s3_prefix: description: The prefix for the location in the S3 bucket. returned: when status is present - type: string + type: str sample: /my/logs availability_zones: description: The Availability Zones for the load balancer. @@ -88,47 +88,47 @@ load_balancers: canonical_hosted_zone_id: description: The ID of the Amazon Route 53 hosted zone associated with the load balancer. returned: when status is present - type: string + type: str sample: ABCDEF12345678 created_time: description: The date and time the load balancer was created. returned: when status is present - type: string + type: str sample: "2015-02-12T02:14:02+00:00" deletion_protection_enabled: description: Indicates whether deletion protection is enabled. returned: when status is present - type: string + type: str sample: true dns_name: description: The public DNS name of the load balancer. returned: when status is present - type: string + type: str sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com idle_timeout_timeout_seconds: description: The idle timeout value, in seconds. returned: when status is present - type: string + type: str sample: 60 ip_address_type: description: The type of IP addresses used by the subnets for the load balancer. returned: when status is present - type: string + type: str sample: ipv4 load_balancer_arn: description: The Amazon Resource Name (ARN) of the load balancer. returned: when status is present - type: string + type: str sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 load_balancer_name: description: The name of the load balancer. returned: when status is present - type: string + type: str sample: my-elb scheme: description: Internet-facing or internal load balancer. returned: when status is present - type: string + type: str sample: internal security_groups: description: The IDs of the security groups for the load balancer. @@ -150,12 +150,12 @@ load_balancers: type: description: The type of load balancer. returned: when status is present - type: string + type: str sample: application vpc_id: description: The ID of the VPC for the load balancer. returned: when status is present - type: string + type: str sample: vpc-0011223344 ''' diff --git a/lib/ansible/modules/cloud/amazon/elb_network_lb.py b/lib/ansible/modules/cloud/amazon/elb_network_lb.py index 50c4564ffd..ac3db9abe0 100644 --- a/lib/ansible/modules/cloud/amazon/elb_network_lb.py +++ b/lib/ansible/modules/cloud/amazon/elb_network_lb.py @@ -140,32 +140,32 @@ availability_zones: canonical_hosted_zone_id: description: The ID of the Amazon Route 53 hosted zone associated with the load balancer. returned: when state is present - type: string + type: str sample: ABCDEF12345678 created_time: description: The date and time the load balancer was created. returned: when state is present - type: string + type: str sample: "2015-02-12T02:14:02+00:00" deletion_protection_enabled: description: Indicates whether deletion protection is enabled. returned: when state is present - type: string + type: str sample: true dns_name: description: The public DNS name of the load balancer. returned: when state is present - type: string + type: str sample: internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com idle_timeout_timeout_seconds: description: The idle timeout value, in seconds. returned: when state is present - type: string + type: str sample: 60 ip_address_type: description: The type of IP addresses used by the subnets for the load balancer. returned: when state is present - type: string + type: str sample: ipv4 listeners: description: Information about the listeners. @@ -175,12 +175,12 @@ listeners: listener_arn: description: The Amazon Resource Name (ARN) of the listener. returned: when state is present - type: string + type: str sample: "" load_balancer_arn: description: The Amazon Resource Name (ARN) of the load balancer. returned: when state is present - type: string + type: str sample: "" port: description: The port on which the load balancer is listening. @@ -190,7 +190,7 @@ listeners: protocol: description: The protocol for connections from clients to the load balancer. returned: when state is present - type: string + type: str sample: HTTPS certificates: description: The SSL server certificate. @@ -200,47 +200,47 @@ listeners: certificate_arn: description: The Amazon Resource Name (ARN) of the certificate. returned: when state is present - type: string + type: str sample: "" ssl_policy: description: The security policy that defines which ciphers and protocols are supported. returned: when state is present - type: string + type: str sample: "" default_actions: description: The default actions for the listener. returned: when state is present - type: string + type: str contains: type: description: The type of action. returned: when state is present - type: string + type: str sample: "" target_group_arn: description: The Amazon Resource Name (ARN) of the target group. returned: when state is present - type: string + type: str sample: "" load_balancer_arn: description: The Amazon Resource Name (ARN) of the load balancer. returned: when state is present - type: string + type: str sample: arn:aws:elasticloadbalancing:ap-southeast-2:0123456789:loadbalancer/app/my-elb/001122334455 load_balancer_name: description: The name of the load balancer. returned: when state is present - type: string + type: str sample: my-elb load_balancing_cross_zone_enabled: description: Indicates whether cross-zone load balancing is enabled. returned: when state is present - type: string + type: str sample: true scheme: description: Internet-facing or internal load balancer. returned: when state is present - type: string + type: str sample: internal state: description: The state of the load balancer. @@ -257,12 +257,12 @@ tags: type: description: The type of load balancer. returned: when state is present - type: string + type: str sample: network vpc_id: description: The ID of the VPC for the load balancer. returned: when state is present - type: string + type: str sample: vpc-0011223344 ''' diff --git a/lib/ansible/modules/cloud/amazon/elb_target_facts.py b/lib/ansible/modules/cloud/amazon/elb_target_facts.py index 2d66b00354..04520ccbd5 100644 --- a/lib/ansible/modules/cloud/amazon/elb_target_facts.py +++ b/lib/ansible/modules/cloud/amazon/elb_target_facts.py @@ -141,14 +141,14 @@ instance_target_groups: contains: target_group_arn: description: The ARN of the target group - type: string + type: str returned: always sample: - "arn:aws:elasticloadbalancing:eu-west-1:111111111111:targetgroup/target-group/deadbeefdeadbeef" target_group_type: description: Which target type is used for this group returned: always - type: string + type: str sample: - ip - instance diff --git a/lib/ansible/modules/cloud/amazon/elb_target_group.py b/lib/ansible/modules/cloud/amazon/elb_target_group.py index 322dfb11b1..4bf1dc59a7 100644 --- a/lib/ansible/modules/cloud/amazon/elb_target_group.py +++ b/lib/ansible/modules/cloud/amazon/elb_target_group.py @@ -227,17 +227,17 @@ health_check_interval_seconds: health_check_path: description: The destination for the health check request. returned: when state present - type: string + type: str sample: /index.html health_check_port: description: The port to use to connect with the target. returned: when state present - type: string + type: str sample: traffic-port health_check_protocol: description: The protocol to use to connect with the target. returned: when state present - type: string + type: str sample: HTTP health_check_timeout_seconds: description: The amount of time, in seconds, during which no response means a failed health check. @@ -269,7 +269,7 @@ port: protocol: description: The protocol to use for routing traffic to the targets. returned: when state present - type: string + type: str sample: HTTP stickiness_enabled: description: Indicates whether sticky sessions are enabled. @@ -284,7 +284,7 @@ stickiness_lb_cookie_duration_seconds: stickiness_type: description: The type of sticky sessions. returned: when state present - type: string + type: str sample: lb_cookie tags: description: The tags attached to the target group. @@ -296,12 +296,12 @@ tags: target_group_arn: description: The Amazon Resource Name (ARN) of the target group. returned: when state present - type: string + type: str sample: "arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211" target_group_name: description: The name of the target group. returned: when state present - type: string + type: str sample: mytargetgroup unhealthy_threshold_count: description: The number of consecutive health check failures required before considering the target unhealthy. @@ -311,7 +311,7 @@ unhealthy_threshold_count: vpc_id: description: The ID of the VPC for the targets. returned: when state present - type: string + type: str sample: vpc-0123456 ''' diff --git a/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py b/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py index 31bbc81847..56a21f911c 100644 --- a/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py +++ b/lib/ansible/modules/cloud/amazon/elb_target_group_facts.py @@ -75,17 +75,17 @@ target_groups: health_check_path: description: The destination for the health check request. returned: always - type: string + type: str sample: /index.html health_check_port: description: The port to use to connect with the target. returned: always - type: string + type: str sample: traffic-port health_check_protocol: description: The protocol to use to connect with the target. returned: always - type: string + type: str sample: HTTP health_check_timeout_seconds: description: The amount of time, in seconds, during which no response means a failed health check. @@ -117,7 +117,7 @@ target_groups: protocol: description: The protocol to use for routing traffic to the targets. returned: always - type: string + type: str sample: HTTP stickiness_enabled: description: Indicates whether sticky sessions are enabled. @@ -132,7 +132,7 @@ target_groups: stickiness_type: description: The type of sticky sessions. returned: always - type: string + type: str sample: lb_cookie tags: description: The tags attached to the target group. @@ -144,12 +144,12 @@ target_groups: target_group_arn: description: The Amazon Resource Name (ARN) of the target group. returned: always - type: string + type: str sample: "arn:aws:elasticloadbalancing:ap-southeast-2:01234567890:targetgroup/mytargetgroup/aabbccddee0044332211" target_group_name: description: The name of the target group. returned: always - type: string + type: str sample: mytargetgroup unhealthy_threshold_count: description: The number of consecutive health check failures required before considering the target unhealthy. @@ -159,7 +159,7 @@ target_groups: vpc_id: description: The ID of the VPC for the targets. returned: always - type: string + type: str sample: vpc-0123456 ''' diff --git a/lib/ansible/modules/cloud/amazon/execute_lambda.py b/lib/ansible/modules/cloud/amazon/execute_lambda.py index 1cfe7e39b6..ebe5bf6927 100644 --- a/lib/ansible/modules/cloud/amazon/execute_lambda.py +++ b/lib/ansible/modules/cloud/amazon/execute_lambda.py @@ -121,7 +121,7 @@ output: sample: "{ 'output': 'something' }" logs: description: The last 4KB of the function logs. Only provided if I(tail_log) is true - type: string + type: str returned: if I(tail_log) == true status: description: C(StatusCode) of API call exit (200 for synchronous invokes, 202 for async) diff --git a/lib/ansible/modules/cloud/amazon/iam.py b/lib/ansible/modules/cloud/amazon/iam.py index 787c4125ce..33ae984854 100644 --- a/lib/ansible/modules/cloud/amazon/iam.py +++ b/lib/ansible/modules/cloud/amazon/iam.py @@ -137,7 +137,7 @@ task: RETURN = ''' role_result: description: the IAM.role dict returned by Boto - type: string + type: str returned: if iam_type=role and state=present sample: { "arn": "arn:aws:iam::A1B2C3D4E5F6:role/my-new-role", diff --git a/lib/ansible/modules/cloud/amazon/iam_group.py b/lib/ansible/modules/cloud/amazon/iam_group.py index c5b38600b9..ff62c27ef8 100644 --- a/lib/ansible/modules/cloud/amazon/iam_group.py +++ b/lib/ansible/modules/cloud/amazon/iam_group.py @@ -118,23 +118,23 @@ group: contains: arn: description: the Amazon Resource Name (ARN) specifying the group - type: string + type: str sample: "arn:aws:iam::1234567890:group/testgroup1" create_date: description: the date and time, in ISO 8601 date-time format, when the group was created - type: string + type: str sample: "2017-02-08T04:36:28+00:00" group_id: description: the stable and unique string identifying the group - type: string + type: str sample: AGPAIDBWE12NSFINE55TM group_name: description: the friendly name that identifies the group - type: string + type: str sample: testgroup1 path: description: the path to the group - type: string + type: str sample: / users: description: list containing all the group members @@ -143,23 +143,23 @@ users: contains: arn: description: the Amazon Resource Name (ARN) specifying the user - type: string + type: str sample: "arn:aws:iam::1234567890:user/test_user1" create_date: description: the date and time, in ISO 8601 date-time format, when the user was created - type: string + type: str sample: "2017-02-08T04:36:28+00:00" user_id: description: the stable and unique string identifying the user - type: string + type: str sample: AIDAIZTPY123YQRS22YU2 user_name: description: the friendly name that identifies the user - type: string + type: str sample: testgroup1 path: description: the path to the user - type: string + type: str sample: / ''' diff --git a/lib/ansible/modules/cloud/amazon/iam_managed_policy.py b/lib/ansible/modules/cloud/amazon/iam_managed_policy.py index 71df98c2eb..073e4a4f23 100644 --- a/lib/ansible/modules/cloud/amazon/iam_managed_policy.py +++ b/lib/ansible/modules/cloud/amazon/iam_managed_policy.py @@ -95,7 +95,7 @@ RETURN = ''' policy: description: Returns the policy json structure, when state == absent this will return the value of the removed policy. returned: success - type: string + type: str sample: '{ "arn": "arn:aws:iam::aws:policy/AdministratorAccess " "attachment_count": 0, diff --git a/lib/ansible/modules/cloud/amazon/iam_role.py b/lib/ansible/modules/cloud/amazon/iam_role.py index 48b6046443..b98400da73 100644 --- a/lib/ansible/modules/cloud/amazon/iam_role.py +++ b/lib/ansible/modules/cloud/amazon/iam_role.py @@ -104,32 +104,32 @@ iam_role: contains: path: description: the path to the role - type: string + type: str returned: always sample: / role_name: description: the friendly name that identifies the role - type: string + type: str returned: always sample: myrole role_id: description: the stable and unique string identifying the role - type: string + type: str returned: always sample: ABCDEFF4EZ4ABCDEFV4ZC arn: description: the Amazon Resource Name (ARN) specifying the role - type: string + type: str returned: always sample: "arn:aws:iam::1234567890:role/mynewrole" create_date: description: the date and time, in ISO 8601 date-time format, when the role was created - type: string + type: str returned: always sample: "2016-08-14T04:36:28+00:00" assume_role_policy_document: description: the policy that grants an entity permission to assume the role - type: string + type: str returned: always sample: { 'statement': [ diff --git a/lib/ansible/modules/cloud/amazon/iam_role_facts.py b/lib/ansible/modules/cloud/amazon/iam_role_facts.py index c663fc0f4a..3eff6cfa3d 100644 --- a/lib/ansible/modules/cloud/amazon/iam_role_facts.py +++ b/lib/ansible/modules/cloud/amazon/iam_role_facts.py @@ -60,16 +60,16 @@ iam_roles: arn: description: Amazon Resource Name for IAM role returned: always - type: string + type: str sample: arn:aws:iam::123456789012:role/AnsibleTestRole assume_role_policy_document: description: Policy Document describing what can assume the role returned: always - type: string + type: str create_date: description: Date IAM role was created returned: always - type: string + type: str sample: '2017-10-23T00:05:08+00:00' inline_policies: description: List of names of inline policies @@ -84,12 +84,12 @@ iam_roles: policy_arn: description: Amazon Resource Name for the policy returned: always - type: string + type: str sample: arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy policy_name: description: Name of managed policy returned: always - type: string + type: str sample: AnsibleTestEC2Policy instance_profiles: description: List of attached instance profiles @@ -99,27 +99,27 @@ iam_roles: arn: description: Amazon Resource Name for the instance profile returned: always - type: string + type: str sample: arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy create_date: description: Date instance profile was created returned: always - type: string + type: str sample: '2017-10-23T00:05:08+00:00' instance_profile_id: description: Amazon Identifier for the instance profile returned: always - type: string + type: str sample: AROAII7ABCD123456EFGH instance_profile_name: description: Name of instance profile returned: always - type: string + type: str sample: AnsibleTestEC2Policy path: description: Path of instance profile returned: always - type: string + type: str sample: / roles: description: List of roles associated with this instance profile @@ -129,17 +129,17 @@ iam_roles: path: description: Path of role returned: always - type: string + type: str sample: / role_id: description: Amazon Identifier for the role returned: always - type: string + type: str sample: AROAII7ABCD123456EFGH role_name: description: Name of the role returned: always - type: string + type: str sample: AnsibleTestRole ''' diff --git a/lib/ansible/modules/cloud/amazon/iam_user.py b/lib/ansible/modules/cloud/amazon/iam_user.py index c2443b2792..f5d319405e 100644 --- a/lib/ansible/modules/cloud/amazon/iam_user.py +++ b/lib/ansible/modules/cloud/amazon/iam_user.py @@ -78,23 +78,23 @@ user: contains: arn: description: the Amazon Resource Name (ARN) specifying the user - type: string + type: str sample: "arn:aws:iam::1234567890:user/testuser1" create_date: description: the date and time, in ISO 8601 date-time format, when the user was created - type: string + type: str sample: "2017-02-08T04:36:28+00:00" user_id: description: the stable and unique string identifying the user - type: string + type: str sample: AGPAIDBWE12NSFINE55TM user_name: description: the friendly name that identifies the user - type: string + type: str sample: testuser1 path: description: the path to the user - type: string + type: str sample: / ''' diff --git a/lib/ansible/modules/cloud/amazon/kinesis_stream.py b/lib/ansible/modules/cloud/amazon/kinesis_stream.py index 70f0d90e18..6461ca1d26 100644 --- a/lib/ansible/modules/cloud/amazon/kinesis_stream.py +++ b/lib/ansible/modules/cloud/amazon/kinesis_stream.py @@ -147,17 +147,17 @@ RETURN = ''' stream_name: description: The name of the Kinesis Stream. returned: when state == present. - type: string + type: str sample: "test-stream" stream_arn: description: The amazon resource identifier returned: when state == present. - type: string + type: str sample: "arn:aws:kinesis:east-side:123456789:stream/test-stream" stream_status: description: The current state of the Kinesis Stream. returned: when state == present. - type: string + type: str sample: "ACTIVE" retention_period_hours: description: Number of hours messages will be kept for a Kinesis Stream. diff --git a/lib/ansible/modules/cloud/amazon/lambda_alias.py b/lib/ansible/modules/cloud/amazon/lambda_alias.py index a12981d782..ce4e4f958c 100644 --- a/lib/ansible/modules/cloud/amazon/lambda_alias.py +++ b/lib/ansible/modules/cloud/amazon/lambda_alias.py @@ -120,22 +120,22 @@ RETURN = ''' alias_arn: description: Full ARN of the function, including the alias returned: success - type: string + type: str sample: arn:aws:lambda:us-west-2:123456789012:function:myFunction:dev description: description: A short description of the alias returned: success - type: string + type: str sample: The development stage for my hot new app function_version: description: The qualifier that the alias refers to returned: success - type: string + type: str sample: $LATEST name: description: The name of the alias assigned returned: success - type: string + type: str sample: dev ''' diff --git a/lib/ansible/modules/cloud/amazon/lambda_policy.py b/lib/ansible/modules/cloud/amazon/lambda_policy.py index 82823ad149..b43133b272 100644 --- a/lib/ansible/modules/cloud/amazon/lambda_policy.py +++ b/lib/ansible/modules/cloud/amazon/lambda_policy.py @@ -123,7 +123,7 @@ RETURN = ''' lambda_policy_action: description: describes what action was taken returned: success - type: string + type: str ''' import json diff --git a/lib/ansible/modules/cloud/amazon/rds.py b/lib/ansible/modules/cloud/amazon/rds.py index 524705e2e0..e51c956ba5 100644 --- a/lib/ansible/modules/cloud/amazon/rds.py +++ b/lib/ansible/modules/cloud/amazon/rds.py @@ -262,67 +262,67 @@ RETURN = ''' engine: description: the name of the database engine returned: when RDS instance exists - type: string + type: str sample: "oracle-se" engine_version: description: the version of the database engine returned: when RDS instance exists - type: string + type: str sample: "11.2.0.4.v6" license_model: description: the license model information returned: when RDS instance exists - type: string + type: str sample: "bring-your-own-license" character_set_name: description: the name of the character set that this instance is associated with returned: when RDS instance exists - type: string + type: str sample: "AL32UTF8" allocated_storage: description: the allocated storage size in gigabytes (GB) returned: when RDS instance exists - type: string + type: str sample: "100" publicly_accessible: description: the accessibility options for the DB instance returned: when RDS instance exists - type: boolean + type: bool sample: "true" latest_restorable_time: description: the latest time to which a database can be restored with point-in-time restore returned: when RDS instance exists - type: string + type: str sample: "1489707802.0" secondary_availability_zone: description: the name of the secondary AZ for a DB instance with multi-AZ support returned: when RDS instance exists and is multy-AZ - type: string + type: str sample: "eu-west-1b" backup_window: description: the daily time range during which automated backups are created if automated backups are enabled returned: when RDS instance exists and automated backups are enabled - type: string + type: str sample: "03:00-03:30" auto_minor_version_upgrade: description: indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window returned: when RDS instance exists - type: boolean + type: bool sample: "true" read_replica_source_dbinstance_identifier: description: the identifier of the source DB instance if this RDS instance is a read replica returned: when read replica RDS instance exists - type: string + type: str sample: "null" db_name: description: the name of the database to create when the DB instance is created returned: when RDS instance exists - type: string + type: str sample: "ASERTG" endpoint: description: the endpoint uri of the database instance returned: when RDS instance exists - type: string + type: str sample: "my-ansible-database.asdfaosdgih.us-east-1.rds.amazonaws.com" port: description: the listening port of the database instance @@ -337,12 +337,12 @@ parameter_groups: parameter_apply_status: description: the status of parameter updates returned: when RDS instance exists - type: string + type: str sample: "in-sync" parameter_group_name: description: the name of the DP parameter group returned: when RDS instance exists - type: string + type: str sample: "testawsrpprodb01spfile-1ujg7nrs7sgyz" option_groups: description: the list of option group memberships for this RDS instance @@ -352,12 +352,12 @@ option_groups: option_group_name: description: the option group name for this RDS instance returned: when RDS instance exists - type: string + type: str sample: "default:oracle-se-11-2" status: description: the status of the RDS instance's option group membership returned: when RDS instance exists - type: string + type: str sample: "in-sync" pending_modified_values: description: a dictionary of changes to the RDS instance that are pending @@ -367,47 +367,47 @@ pending_modified_values: db_instance_class: description: the new DB instance class for this RDS instance that will be applied or is in progress returned: when RDS instance exists - type: string + type: str sample: "null" db_instance_identifier: description: the new DB instance identifier this RDS instance that will be applied or is in progress returned: when RDS instance exists - type: string + type: str sample: "null" allocated_storage: description: the new allocated storage size for this RDS instance that will be applied or is in progress returned: when RDS instance exists - type: string + type: str sample: "null" backup_retention_period: description: the pending number of days for which automated backups are retained returned: when RDS instance exists - type: string + type: str sample: "null" engine_version: description: indicates the database engine version returned: when RDS instance exists - type: string + type: str sample: "null" iops: description: the new provisioned IOPS value for this RDS instance that will be applied or is being applied returned: when RDS instance exists - type: string + type: str sample: "null" master_user_password: description: the pending or in-progress change of the master credentials for this RDS instance returned: when RDS instance exists - type: string + type: str sample: "null" multi_az: description: indicates that the single-AZ RDS instance is to change to a multi-AZ deployment returned: when RDS instance exists - type: string + type: str sample: "null" port: description: specifies the pending port for this RDS instance returned: when RDS instance exists - type: string + type: str sample: "null" db_subnet_groups: description: information on the subnet group associated with this RDS instance @@ -417,17 +417,17 @@ db_subnet_groups: description: description: the subnet group associated with the DB instance returned: when RDS instance exists - type: string + type: str sample: "Subnets for the UAT RDS SQL DB Instance" name: description: the name of the DB subnet group returned: when RDS instance exists - type: string + type: str sample: "samplesubnetgrouprds-j6paiqkxqp4z" status: description: the status of the DB subnet group returned: when RDS instance exists - type: string + type: str sample: "complete" subnets: description: the description of the DB subnet group @@ -442,22 +442,22 @@ db_subnet_groups: name: description: avaialbility zone returned: when RDS instance exists - type: string + type: str sample: "eu-west-1b" provisioned_iops_capable: description: whether provisioned iops are available in AZ subnet returned: when RDS instance exists - type: boolean + type: bool sample: "false" identifier: description: the identifier of the subnet returned: when RDS instance exists - type: string + type: str sample: "subnet-3fdba63e" status: description: the status of the subnet returned: when RDS instance exists - type: string + type: str sample: "active" ''' diff --git a/lib/ansible/modules/cloud/amazon/rds_instance.py b/lib/ansible/modules/cloud/amazon/rds_instance.py index 179ac84274..ae6da7947f 100644 --- a/lib/ansible/modules/cloud/amazon/rds_instance.py +++ b/lib/ansible/modules/cloud/amazon/rds_instance.py @@ -414,7 +414,7 @@ auto_minor_version_upgrade: availability_zone: description: The availability zone for the DB instance. returned: always - type: string + type: str sample: us-east-1f backup_retention_period: description: The number of days for which automated backups are retained. @@ -424,7 +424,7 @@ backup_retention_period: ca_certificate_identifier: description: The identifier of the CA certificate for the DB instance. returned: always - type: string + type: str sample: rds-ca-2015 copy_tags_to_snapshot: description: Whether tags are copied from the DB instance to snapshots of the DB instance. @@ -434,17 +434,17 @@ copy_tags_to_snapshot: db_instance_arn: description: The Amazon Resource Name (ARN) for the DB instance. returned: always - type: string + type: str sample: arn:aws:rds:us-east-1:123456789012:db:ansible-test db_instance_class: description: The name of the compute and memory capacity class of the DB instance. returned: always - type: string + type: str sample: db.m4.large db_instance_identifier: description: The identifier of the DB instance returned: always - type: string + type: str sample: ansible-test db_instance_port: description: The port that the DB instance listens on. @@ -454,7 +454,7 @@ db_instance_port: db_instance_status: description: The current state of this database. returned: always - type: string + type: str sample: stopped db_parameter_groups: description: The list of DB parameter groups applied to this DB instance. @@ -464,12 +464,12 @@ db_parameter_groups: db_parameter_group_name: description: The name of the DP parameter group. returned: always - type: string + type: str sample: default.mariadb10.0 parameter_apply_status: description: The status of parameter updates. returned: always - type: string + type: str sample: in-sync db_security_groups: description: A list of DB security groups associated with this DB instance. @@ -484,17 +484,17 @@ db_subnet_group: db_subnet_group_description: description: The description of the DB subnet group. returned: always - type: string + type: str sample: default db_subnet_group_name: description: The name of the DB subnet group. returned: always - type: string + type: str sample: default subnet_group_status: description: The status of the DB subnet group. returned: always - type: string + type: str sample: Complete subnets: description: A list of Subnet elements. @@ -509,27 +509,27 @@ db_subnet_group: name: description: The name of the Availability Zone. returned: always - type: string + type: str sample: us-east-1c subnet_identifier: description: The ID of the subnet. returned: always - type: string + type: str sample: subnet-12345678 subnet_status: description: The status of the subnet. returned: always - type: string + type: str sample: Active vpc_id: description: The VpcId of the DB subnet group. returned: always - type: string + type: str sample: vpc-12345678 dbi_resource_id: description: The AWS Region-unique, immutable identifier for the DB instance. returned: always - type: string + type: str sample: db-UHV3QRNWX4KB6GALCIGRML6QFA domain_memberships: description: The Active Directory Domain membership records associated with the DB instance. @@ -544,12 +544,12 @@ endpoint: address: description: The DNS address of the DB instance. returned: always - type: string + type: str sample: ansible-test.cvlrtwiennww.us-east-1.rds.amazonaws.com hosted_zone_id: description: The ID that Amazon Route 53 assigns when you create a hosted zone. returned: always - type: string + type: str sample: ZTR2ITUGPA61AM port: description: The port that the database engine is listening on. @@ -559,12 +559,12 @@ endpoint: engine: description: The database engine version. returned: always - type: string + type: str sample: mariadb engine_version: description: The database engine version. returned: always - type: string + type: str sample: 10.0.35 iam_database_authentication_enabled: description: Whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. @@ -574,27 +574,27 @@ iam_database_authentication_enabled: instance_create_time: description: The date and time the DB instance was created. returned: always - type: string + type: str sample: '2018-07-04T16:48:35.332000+00:00' kms_key_id: description: The AWS KMS key identifier for the encrypted DB instance when storage_encrypted is true. returned: When storage_encrypted is true - type: string + type: str sample: arn:aws:kms:us-east-1:123456789012:key/70c45553-ad2e-4a85-9f14-cfeb47555c33 latest_restorable_time: description: The latest time to which a database can be restored with point-in-time restore. returned: always - type: string + type: str sample: '2018-07-04T16:50:50.642000+00:00' license_model: description: The License model information for this DB instance. returned: always - type: string + type: str sample: general-public-license master_username: description: The master username for the DB instance. returned: always - type: string + type: str sample: test monitoring_interval: description: @@ -616,12 +616,12 @@ option_group_memberships: option_group_name: description: The name of the option group that the instance belongs to. returned: always - type: string + type: str sample: default:mariadb-10-0 status: description: The status of the DB instance's option group membership. returned: always - type: string + type: str sample: in-sync pending_modified_values: description: The changes to the DB instance that are pending. @@ -636,12 +636,12 @@ performance_insights_enabled: preferred_backup_window: description: The daily time range during which automated backups are created if automated backups are enabled. returned: always - type: string + type: str sample: 07:01-07:31 preferred_maintenance_window: description: The weekly time range (in UTC) during which system maintenance can occur. returned: always - type: string + type: str sample: sun:09:31-sun:10:01 publicly_accessible: description: @@ -663,7 +663,7 @@ storage_encrypted: storage_type: description: The storage type to be associated with the DB instance. returned: always - type: string + type: str sample: standard tags: description: A dictionary of tags associated with the DB instance. @@ -678,12 +678,12 @@ vpc_security_groups: status: description: The status of the VPC security group. returned: always - type: string + type: str sample: active vpc_security_group_id: description: The name of the VPC security group. returned: always - type: string + type: str sample: sg-12345678 ''' diff --git a/lib/ansible/modules/cloud/amazon/rds_instance_facts.py b/lib/ansible/modules/cloud/amazon/rds_instance_facts.py index f235f81c7a..0a479e8caf 100644 --- a/lib/ansible/modules/cloud/amazon/rds_instance_facts.py +++ b/lib/ansible/modules/cloud/amazon/rds_instance_facts.py @@ -66,7 +66,7 @@ instances: availability_zone: description: Availability Zone in which the database resides returned: always - type: string + type: str sample: us-west-2b backup_retention_period: description: Days for which backups are retained @@ -76,7 +76,7 @@ instances: ca_certificate_identifier: description: ID for the CA certificate returned: always - type: string + type: str sample: rds-ca-2015 copy_tags_to_snapshot: description: Whether DB tags should be copied to the snapshot @@ -86,17 +86,17 @@ instances: db_instance_arn: description: ARN of the database instance returned: always - type: string + type: str sample: arn:aws:rds:us-west-2:111111111111:db:helloworld-rds db_instance_class: description: Instance class of the database instance returned: always - type: string + type: str sample: db.t2.small db_instance_identifier: description: Database instance identifier returned: always - type: string + type: str sample: helloworld-rds db_instance_port: description: Port used by the database instance @@ -106,12 +106,12 @@ instances: db_instance_status: description: Status of the database instance returned: always - type: string + type: str sample: available db_name: description: Name of the database returned: always - type: string + type: str sample: management db_parameter_groups: description: List of database parameter groups @@ -121,12 +121,12 @@ instances: db_parameter_group_name: description: Name of the database parameter group returned: always - type: string + type: str sample: psql-pg-helloworld parameter_apply_status: description: Whether the parameter group has been applied returned: always - type: string + type: str sample: in-sync db_security_groups: description: List of security groups used by the database instance @@ -141,17 +141,17 @@ instances: db_subnet_group_description: description: Description of the DB subnet group returned: always - type: string + type: str sample: My database subnet group db_subnet_group_name: description: Name of the database subnet group returned: always - type: string + type: str sample: my-subnet-group subnet_group_status: description: Subnet group status returned: always - type: string + type: str sample: Complete subnets: description: List of subnets in the subnet group @@ -166,27 +166,27 @@ instances: name: description: Name of the availability zone returned: always - type: string + type: str sample: us-west-2c subnet_identifier: description: Subnet ID returned: always - type: string + type: str sample: subnet-abcd1234 subnet_status: description: Subnet status returned: always - type: string + type: str sample: Active vpc_id: description: VPC id of the subnet group returned: always - type: string + type: str sample: vpc-abcd1234 dbi_resource_id: description: AWS Region-unique, immutable identifier for the DB instance returned: always - type: string + type: str sample: db-AAAAAAAAAAAAAAAAAAAAAAAAAA domain_memberships: description: List of domain memberships @@ -201,12 +201,12 @@ instances: address: description: Database endpoint address returned: always - type: string + type: str sample: helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com hosted_zone_id: description: Route53 hosted zone ID returned: always - type: string + type: str sample: Z1PABCD0000000 port: description: Database endpoint port @@ -216,12 +216,12 @@ instances: engine: description: Database engine returned: always - type: string + type: str sample: postgres engine_version: description: Database engine version returned: always - type: string + type: str sample: 9.5.10 iam_database_authentication_enabled: description: Whether database authentication through IAM is enabled @@ -231,27 +231,27 @@ instances: instance_create_time: description: Date and time the instance was created returned: always - type: string + type: str sample: '2017-10-10T04:00:07.434000+00:00' kms_key_id: description: KMS Key ID returned: always - type: string + type: str sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-0000-abcd-1111-0123456789ab latest_restorable_time: description: Latest time to which a database can be restored with point-in-time restore returned: always - type: string + type: str sample: '2018-05-17T00:03:56+00:00' license_model: description: License model returned: always - type: string + type: str sample: postgresql-license master_username: description: Database master username returned: always - type: string + type: str sample: dbadmin monitoring_interval: description: Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance @@ -271,12 +271,12 @@ instances: option_group_name: description: Option group name returned: always - type: string + type: str sample: default:postgres-9-5 status: description: Status of option group returned: always - type: string + type: str sample: in-sync pending_modified_values: description: Modified values pending application @@ -291,12 +291,12 @@ instances: preferred_backup_window: description: Preferred backup window returned: always - type: string + type: str sample: 04:00-05:00 preferred_maintenance_window: description: Preferred maintenance window returned: always - type: string + type: str sample: mon:05:00-mon:05:30 publicly_accessible: description: Whether the DB is publicly accessible @@ -316,7 +316,7 @@ instances: storage_type: description: Storage type of the Database instance returned: always - type: string + type: str sample: gp2 tags: description: Tags used by the database instance @@ -331,12 +331,12 @@ instances: status: description: Status of the VPC security group returned: always - type: string + type: str sample: active vpc_security_group_id: description: VPC Security Group ID returned: always - type: string + type: str sample: sg-abcd1234 ''' diff --git a/lib/ansible/modules/cloud/amazon/rds_param_group.py b/lib/ansible/modules/cloud/amazon/rds_param_group.py index 611a6f02e5..40e98b83f5 100644 --- a/lib/ansible/modules/cloud/amazon/rds_param_group.py +++ b/lib/ansible/modules/cloud/amazon/rds_param_group.py @@ -97,19 +97,19 @@ EXAMPLES = ''' RETURN = ''' db_parameter_group_name: description: Name of DB parameter group - type: string + type: str returned: when state is present db_parameter_group_family: description: DB parameter group family that this DB parameter group is compatible with. - type: string + type: str returned: when state is present db_parameter_group_arn: description: ARN of the DB parameter group - type: string + type: str returned: when state is present description: description: description of the DB parameter group - type: string + type: str returned: when state is present errors: description: list of errors from attempting to modify parameters that are not modifiable diff --git a/lib/ansible/modules/cloud/amazon/rds_snapshot_facts.py b/lib/ansible/modules/cloud/amazon/rds_snapshot_facts.py index 81df78014f..f565463cf9 100644 --- a/lib/ansible/modules/cloud/amazon/rds_snapshot_facts.py +++ b/lib/ansible/modules/cloud/amazon/rds_snapshot_facts.py @@ -78,22 +78,22 @@ snapshots: availability_zone: description: The availability zone of the database from which the snapshot was taken returned: always - type: string + type: str sample: us-west-2b db_instance_identifier: description: Database instance identifier returned: always - type: string + type: str sample: hello-world-rds db_snapshot_arn: description: Snapshot ARN returned: always - type: string + type: str sample: arn:aws:rds:us-west-2:111111111111:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03 db_snapshot_identifier: description: Snapshot name returned: always - type: string + type: str sample: rds:hello-world-rds-us1-2018-05-16-04-03 encrypted: description: Whether the snapshot was encrypted @@ -103,12 +103,12 @@ snapshots: engine: description: Database engine returned: always - type: string + type: str sample: postgres engine_version: description: Database engine version returned: always - type: string + type: str sample: 9.5.10 iam_database_authentication_enabled: description: Whether database authentication through IAM is enabled @@ -118,27 +118,27 @@ snapshots: instance_create_time: description: Time the Instance was created returned: always - type: string + type: str sample: '2017-10-10T04:00:07.434000+00:00' kms_key_id: description: ID of the KMS Key encrypting the snapshot returned: always - type: string + type: str sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab license_model: description: License model returned: always - type: string + type: str sample: postgresql-license master_username: description: Database master username returned: always - type: string + type: str sample: dbadmin option_group_name: description: Database option group name returned: always - type: string + type: str sample: default:postgres-9-5 percent_progress: description: Perecent progress of snapshot @@ -148,22 +148,22 @@ snapshots: snapshot_create_time: description: Time snapshot was created returned: always - type: string + type: str sample: '2018-05-16T04:03:33.871000+00:00' snapshot_type: description: Type of snapshot returned: always - type: string + type: str sample: automated status: description: Status of snapshot returned: always - type: string + type: str sample: available storage_type: description: Storage type of underlying DB returned: always - type: string + type: str sample: gp2 tags: description: Snapshot tags @@ -173,7 +173,7 @@ snapshots: vpc_id: description: ID of VPC containing the DB returned: always - type: string + type: str sample: vpc-abcd1234 cluster_snapshots: description: List of cluster snapshots @@ -195,32 +195,32 @@ cluster_snapshots: cluster_create_time: description: Date and time the cluster was created returned: always - type: string + type: str sample: '2018-05-17T00:13:40.223000+00:00' db_cluster_identifier: description: Database cluster identifier returned: always - type: string + type: str sample: test-aurora-cluster db_cluster_snapshot_arn: description: ARN of the database snapshot returned: always - type: string + type: str sample: arn:aws:rds:ca-central-1:111111111111:cluster-snapshot:test-aurora-snapshot db_cluster_snapshot_identifier: description: Snapshot identifier returned: always - type: string + type: str sample: test-aurora-snapshot engine: description: Database engine returned: always - type: string + type: str sample: aurora engine_version: description: Database engine version returned: always - type: string + type: str sample: 5.6.10a iam_database_authentication_enabled: description: Whether database authentication through IAM is enabled @@ -230,17 +230,17 @@ cluster_snapshots: kms_key_id: description: ID of the KMS Key encrypting the snapshot returned: always - type: string + type: str sample: arn:aws:kms:ca-central-1:111111111111:key/abcd1234-abcd-1111-aaaa-0123456789ab license_model: description: License model returned: always - type: string + type: str sample: aurora master_username: description: Database master username returned: always - type: string + type: str sample: shertel percent_progress: description: Perecent progress of snapshot @@ -255,17 +255,17 @@ cluster_snapshots: snapshot_create_time: description: Date and time when the snapshot was created returned: always - type: string + type: str sample: '2018-05-17T00:23:23.731000+00:00' snapshot_type: description: Type of snapshot returned: always - type: string + type: str sample: manual status: description: Status of snapshot returned: always - type: string + type: str sample: creating storage_encrypted: description: Whether the snapshot is encrypted @@ -280,7 +280,7 @@ cluster_snapshots: vpc_id: description: VPC of the database returned: always - type: string + type: str sample: vpc-abcd1234 ''' diff --git a/lib/ansible/modules/cloud/amazon/rds_subnet_group.py b/lib/ansible/modules/cloud/amazon/rds_subnet_group.py index 0677403272..0aa95a7a45 100644 --- a/lib/ansible/modules/cloud/amazon/rds_subnet_group.py +++ b/lib/ansible/modules/cloud/amazon/rds_subnet_group.py @@ -66,15 +66,15 @@ subnet_group: name: description: The name of the DB subnet group returned: I(state=present) - type: string + type: str description: description: The description of the DB subnet group returned: I(state=present) - type: string + type: str vpc_id: description: The VpcId of the DB subnet group returned: I(state=present) - type: string + type: str subnet_ids: description: Contains a list of Subnet IDs returned: I(state=present) @@ -82,7 +82,7 @@ subnet_group: status: description: The status of the DB subnet group returned: I(state=present) - type: string + type: str ''' try: diff --git a/lib/ansible/modules/cloud/amazon/redshift.py b/lib/ansible/modules/cloud/amazon/redshift.py index 19f7c821d6..018a9a7082 100644 --- a/lib/ansible/modules/cloud/amazon/redshift.py +++ b/lib/ansible/modules/cloud/amazon/redshift.py @@ -163,7 +163,7 @@ cluster: identifier: description: Id of the cluster. returned: success - type: string + type: str sample: "new_redshift_cluster" create_time: description: Time of the cluster creation as timestamp. @@ -173,32 +173,32 @@ cluster: status: description: Stutus of the cluster. returned: success - type: string + type: str sample: "available" db_name: description: Name of the database. returned: success - type: string + type: str sample: "new_db_name" availability_zone: description: Amazon availability zone where the cluster is located. returned: success - type: string + type: str sample: "us-east-1b" maintenance_window: description: Time frame when maintenance/upgrade are done. returned: success - type: string + type: str sample: "sun:09:30-sun:10:00" private_ip_address: description: Private IP address of the main node. returned: success - type: string + type: str sample: "10.10.10.10" public_ip_address: description: Public IP address of the main node. returned: success - type: string + type: str sample: "0.0.0.0" port: description: Port of the cluster. @@ -208,7 +208,7 @@ cluster: url: description: FQDN of the main cluster node. returned: success - type: string + type: str sample: "new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com" ''' diff --git a/lib/ansible/modules/cloud/amazon/redshift_facts.py b/lib/ansible/modules/cloud/amazon/redshift_facts.py index 699146b064..239f2d21e9 100644 --- a/lib/ansible/modules/cloud/amazon/redshift_facts.py +++ b/lib/ansible/modules/cloud/amazon/redshift_facts.py @@ -74,37 +74,37 @@ RETURN = ''' cluster_identifier: description: Unique key to identify the cluster. returned: success - type: string + type: str sample: "redshift-identifier" node_type: description: The node type for nodes in the cluster. returned: success - type: string + type: str sample: "ds2.xlarge" cluster_status: description: Current state of the cluster. returned: success - type: string + type: str sample: "available" modify_status: description: The status of a modify operation. returned: optional - type: string + type: str sample: "" master_username: description: The master user name for the cluster. returned: success - type: string + type: str sample: "admin" db_name: description: The name of the initial database that was created when the cluster was created. returned: success - type: string + type: str sample: "dev" endpoint: description: The connection endpoint. returned: success - type: string + type: str sample: { "address": "cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com", "port": 5439 @@ -112,7 +112,7 @@ endpoint: cluster_create_time: description: The date and time that the cluster was created. returned: success - type: string + type: str sample: "2016-05-10T08:33:16.629000+00:00" automated_snapshot_retention_period: description: The number of days that automatic cluster snapshots are retained. @@ -157,22 +157,22 @@ cluster_paramater_groups: cluster_subnet_group_name: description: The name of the subnet group that is associated with the cluster. returned: success - type: string + type: str sample: "redshift-subnet" vpc_id: description: The identifier of the VPC the cluster is in, if the cluster is in a VPC. returned: success - type: string + type: str sample: "vpc-1234567" availability_zone: description: The name of the Availability Zone in which the cluster is located. returned: success - type: string + type: str sample: "us-east-1b" preferred_maintenance_window: description: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. returned: success - type: string + type: str sample: "tue:07:30-tue:08:00" pending_modified_values: description: A value that, if present, indicates that changes to the cluster are pending. @@ -182,14 +182,14 @@ pending_modified_values: cluster_version: description: The version ID of the Amazon Redshift engine that is running on the cluster. returned: success - type: string + type: str sample: "1.0" allow_version_upgrade: description: > A Boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. returned: success - type: boolean + type: bool sample: true|false number_of_nodes: description: The number of compute nodes in the cluster. @@ -199,12 +199,12 @@ number_of_nodes: publicly_accessible: description: A Boolean value that, if true , indicates that the cluster can be accessed from a public network. returned: success - type: boolean + type: bool sample: true|false encrypted: description: Boolean value that, if true , indicates that data in the cluster is encrypted at rest. returned: success - type: boolean + type: bool sample: true|false restore_status: description: A value that describes the status of a cluster restore action. @@ -226,7 +226,7 @@ cluster_snapshot_copy_status: cluster_public_keys: description: The public key for the cluster. returned: success - type: string + type: str sample: "ssh-rsa anjigfam Amazon-Redshift\n" cluster_nodes: description: The nodes in the cluster. @@ -252,7 +252,7 @@ elastic_ip_status: cluster_revision_number: description: The specific revision number of the database in the cluster. returned: success - type: string + type: str sample: "1231" tags: description: The list of tags for the cluster. @@ -262,12 +262,12 @@ tags: kms_key_id: description: The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster. returned: success - type: string + type: str sample: "" enhanced_vpc_routing: description: An option that specifies whether to create the cluster with enhanced VPC routing enabled. returned: success - type: boolean + type: bool sample: true|false iam_roles: description: List of IAM roles attached to the cluster. diff --git a/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py b/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py index 7588e1d012..86dfb004af 100644 --- a/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py +++ b/lib/ansible/modules/cloud/amazon/redshift_subnet_group.py @@ -72,12 +72,12 @@ group: name: description: name of the Redshift subnet group returned: success - type: string + type: str sample: "redshift_subnet_group_name" vpc_id: description: Id of the VPC where the subnet is located returned: success - type: string + type: str sample: "vpc-aabb1122" ''' diff --git a/lib/ansible/modules/cloud/amazon/route53.py b/lib/ansible/modules/cloud/amazon/route53.py index 09b8f20585..8533df02af 100644 --- a/lib/ansible/modules/cloud/amazon/route53.py +++ b/lib/ansible/modules/cloud/amazon/route53.py @@ -173,7 +173,7 @@ set: record: description: domain name for the record set returned: always - type: string + type: str sample: new.foo.com. region: description: "" @@ -183,17 +183,17 @@ set: ttl: description: resource record cache TTL returned: always - type: string + type: str sample: '3600' type: description: record set type returned: always - type: string + type: str sample: A value: description: value returned: always - type: string + type: str sample: 52.43.18.27 values: description: values @@ -204,12 +204,12 @@ set: weight: description: weight of the record returned: always - type: string + type: str sample: '3' zone: description: zone this record set belongs to returned: always - type: string + type: str sample: foo.bar.com. ''' diff --git a/lib/ansible/modules/cloud/amazon/route53_zone.py b/lib/ansible/modules/cloud/amazon/route53_zone.py index 8063991457..1a560e60dd 100644 --- a/lib/ansible/modules/cloud/amazon/route53_zone.py +++ b/lib/ansible/modules/cloud/amazon/route53_zone.py @@ -91,12 +91,12 @@ RETURN = ''' comment: description: optional hosted zone comment returned: when hosted zone exists - type: string + type: str sample: "Private zone" name: description: hosted zone name returned: when hosted zone exists - type: string + type: str sample: "private.local." private_zone: description: whether hosted zone is private or public @@ -106,22 +106,22 @@ private_zone: vpc_id: description: id of vpc attached to private hosted zone returned: for private hosted zone - type: string + type: str sample: "vpc-1d36c84f" vpc_region: description: region of vpc attached to private hosted zone returned: for private hosted zone - type: string + type: str sample: "eu-west-1" zone_id: description: hosted zone id returned: when hosted zone exists - type: string + type: str sample: "Z6JQG9820BEFMW" delegation_set_id: description: id of the associated reusable delegation set returned: for public hosted zones, if they have been associated with a reusable delegation set - type: string + type: str sample: "A1BCDEF2GHIJKL" ''' diff --git a/lib/ansible/modules/cloud/amazon/s3_website.py b/lib/ansible/modules/cloud/amazon/s3_website.py index 4a5f81e17f..9ad13e6089 100644 --- a/lib/ansible/modules/cloud/amazon/s3_website.py +++ b/lib/ansible/modules/cloud/amazon/s3_website.py @@ -87,7 +87,7 @@ index_document: suffix: description: suffix that is appended to a request that is for a directory on the website endpoint returned: success - type: string + type: str sample: index.html error_document: description: error document @@ -97,7 +97,7 @@ error_document: key: description: object key name to use when a 4XX class error occurs returned: when error_document parameter set - type: string + type: str sample: error.html redirect_all_requests_to: description: where to redirect requests @@ -107,7 +107,7 @@ redirect_all_requests_to: host_name: description: name of the host where requests will be redirected. returned: when redirect all requests parameter set - type: string + type: str sample: ansible.com routing_rules: description: routing rules @@ -118,20 +118,20 @@ routing_rules: host_name: description: name of the host where requests will be redirected. returned: when host name set as part of redirect rule - type: string + type: str sample: ansible.com condition: key_prefix_equals: description: object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html returned: when routing rule present - type: string + type: str sample: docs/ redirect: replace_key_prefix_with: description: object key prefix to use in the redirect request returned: when routing rule present - type: string + type: str sample: documents/ ''' diff --git a/lib/ansible/modules/cloud/amazon/sns.py b/lib/ansible/modules/cloud/amazon/sns.py index 557b3e925a..9a391da3c2 100644 --- a/lib/ansible/modules/cloud/amazon/sns.py +++ b/lib/ansible/modules/cloud/amazon/sns.py @@ -114,12 +114,12 @@ RETURN = """ msg: description: Human-readable diagnostic information returned: always - type: string + type: str sample: OK message_id: description: The message ID of the submitted message returned: when success - type: string + type: str sample: 2f681ef0-6d76-5c94-99b2-4ae3996ce57b """ diff --git a/lib/ansible/modules/cloud/amazon/sns_topic.py b/lib/ansible/modules/cloud/amazon/sns_topic.py index 4851307830..76fd5314bd 100644 --- a/lib/ansible/modules/cloud/amazon/sns_topic.py +++ b/lib/ansible/modules/cloud/amazon/sns_topic.py @@ -99,7 +99,7 @@ EXAMPLES = """ RETURN = ''' sns_arn: description: The ARN of the topic you are modifying - type: string + type: str returned: always sample: "arn:aws:sns:us-east-2:111111111111:my_topic_name" sns_topic: @@ -120,36 +120,36 @@ sns_topic: delivery_policy: description: Delivery policy for the SNS topic returned: when topic is owned by this AWS account - type: string + type: str sample: > {"http":{"defaultHealthyRetryPolicy":{"minDelayTarget":20,"maxDelayTarget":20,"numRetries":3,"numMaxDelayRetries":0, "numNoDelayRetries":0,"numMinDelayRetries":0,"backoffFunction":"linear"},"disableSubscriptionOverrides":false}} display_name: description: Display name for SNS topic returned: when topic is owned by this AWS account - type: string + type: str sample: My topic name name: description: Topic name returned: always - type: string + type: str sample: ansible-test-dummy-topic owner: description: AWS account that owns the topic returned: when topic is owned by this AWS account - type: string + type: str sample: '111111111111' policy: description: Policy for the SNS topic returned: when topic is owned by this AWS account - type: string + type: str sample: > {"Version":"2012-10-17","Id":"SomePolicyId","Statement":[{"Sid":"ANewSid","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::111111111111:root"}, "Action":"sns:Subscribe","Resource":"arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic","Condition":{"StringEquals":{"sns:Protocol":"email"}}}]} state: description: whether the topic is present or absent returned: always - type: string + type: str sample: present subscriptions: description: List of subscribers to the topic in this AWS account @@ -184,7 +184,7 @@ sns_topic: subscriptions_pending: description: Count of pending subscriptions returned: when topic is owned by this AWS account - type: string + type: str sample: '0' subscriptions_purge: description: Whether or not purge_subscriptions was set @@ -194,7 +194,7 @@ sns_topic: topic_arn: description: ARN of the SNS topic (equivalent to sns_arn) returned: when topic is owned by this AWS account - type: string + type: str sample: arn:aws:sns:us-east-2:111111111111:ansible-test-dummy-topic topic_created: description: Whether the topic was created diff --git a/lib/ansible/modules/cloud/amazon/sqs_queue.py b/lib/ansible/modules/cloud/amazon/sqs_queue.py index f9d62195d4..4a3393448e 100644 --- a/lib/ansible/modules/cloud/amazon/sqs_queue.py +++ b/lib/ansible/modules/cloud/amazon/sqs_queue.py @@ -87,12 +87,12 @@ message_retention_period: sample: 345600 name: description: Name of the SQS Queue - type: string + type: str returned: always sample: "queuename-987d2de0" queue_arn: description: The queue's Amazon resource name (ARN). - type: string + type: str returned: on successful creation or update of the queue sample: 'arn:aws:sqs:us-east-1:199999999999:queuename-987d2de0' receive_message_wait_time: @@ -102,7 +102,7 @@ receive_message_wait_time: sample: 0 region: description: Region that the queue was created within - type: string + type: str returned: always sample: 'us-east-1' ''' diff --git a/lib/ansible/modules/cloud/atomic/atomic_container.py b/lib/ansible/modules/cloud/atomic/atomic_container.py index cf6cb9ad6f..d03008c83f 100644 --- a/lib/ansible/modules/cloud/atomic/atomic_container.py +++ b/lib/ansible/modules/cloud/atomic/atomic_container.py @@ -86,7 +86,7 @@ RETURN = ''' msg: description: The command standard output returned: always - type: string + type: str sample: [u'Using default tag: latest ...'] ''' diff --git a/lib/ansible/modules/cloud/atomic/atomic_host.py b/lib/ansible/modules/cloud/atomic/atomic_host.py index 5e35dad64f..b0de3d1078 100644 --- a/lib/ansible/modules/cloud/atomic/atomic_host.py +++ b/lib/ansible/modules/cloud/atomic/atomic_host.py @@ -48,7 +48,7 @@ RETURN = ''' msg: description: The command standard output returned: always - type: string + type: str sample: 'Already on latest' ''' import os diff --git a/lib/ansible/modules/cloud/atomic/atomic_image.py b/lib/ansible/modules/cloud/atomic/atomic_image.py index c39faf38be..d072ab8e48 100644 --- a/lib/ansible/modules/cloud/atomic/atomic_image.py +++ b/lib/ansible/modules/cloud/atomic/atomic_image.py @@ -66,7 +66,7 @@ RETURN = ''' msg: description: The command standard output returned: always - type: string + type: str sample: [u'Using default tag: latest ...'] ''' import traceback diff --git a/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py b/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py index cc8ece8421..2450b843ba 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_cdnendpoint.py @@ -145,7 +145,7 @@ RETURN = ''' state: description: Current state of the Azure CDN endpoint returned: always - type: string + type: str id: description: - Id of the CDN endpoint. diff --git a/lib/ansible/modules/cloud/azure/azure_rm_deployment.py b/lib/ansible/modules/cloud/azure/azure_rm_deployment.py index a078c52b0b..2d013050d7 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_deployment.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_deployment.py @@ -341,11 +341,11 @@ deployment: sample: group_name: description: Name of the resource group - type: string + type: str returned: always id: description: The Azure ID of the deployment - type: string + type: str returned: always instances: description: Provides the public IP addresses for each VM instance. @@ -353,7 +353,7 @@ deployment: returned: always name: description: Name of the deployment - type: string + type: str returned: always outputs: description: Dictionary of outputs received from the deployment diff --git a/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py b/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py index 8923e1cf84..be848a51db 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_rediscache.py @@ -163,14 +163,14 @@ RETURN = ''' id: description: Id of the redis cache. returned: always - type: string + type: str sample: { "id": "/subscriptions/<subs_id>/resourceGroups/rg/providers/Microsoft.Cache/Redis/redis1" } host_name: description: Host name of the redis cache. returned: state is present - type: string + type: str sample: { "host_name": "redis1.redis.cache.windows.net" } diff --git a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py index c0ae41052e..2ade4cfb22 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py @@ -504,7 +504,7 @@ RETURN = ''' powerstate: description: Indicates if the state is running, stopped, deallocated, generalized returned: always - type: string + type: str example: running deleted_vhd_uris: description: List of deleted Virtual Hard Disk URIs. diff --git a/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py b/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py index 44b6087c92..b0da24af71 100644 --- a/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py +++ b/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py @@ -113,7 +113,7 @@ RETURN = ''' firewall_policy_id: description: The fire wall policy id returned: success - type: string + type: str sample: fc36f1bfd47242e488a9c44346438c05 firewall_policy: description: The fire wall policy information diff --git a/lib/ansible/modules/cloud/cloudscale/cloudscale_floating_ip.py b/lib/ansible/modules/cloud/cloudscale/cloudscale_floating_ip.py index 4d9f8eebf6..f50b614314 100644 --- a/lib/ansible/modules/cloud/cloudscale/cloudscale_floating_ip.py +++ b/lib/ansible/modules/cloud/cloudscale/cloudscale_floating_ip.py @@ -116,37 +116,37 @@ RETURN = ''' href: description: The API URL to get details about this floating IP. returned: success when state == present - type: string + type: str sample: https://api.cloudscale.ch/v1/floating-ips/2001:db8::cafe network: description: The CIDR notation of the network that is routed to your server. returned: success when state == present - type: string + type: str sample: 2001:db8::cafe/128 next_hop: description: Your floating IP is routed to this IP address. returned: success when state == present - type: string + type: str sample: 2001:db8:dead:beef::42 reverse_ptr: description: The reverse pointer for this floating IP address. returned: success when state == present - type: string + type: str sample: 185-98-122-176.cust.cloudscale.ch server: description: The floating IP is routed to this server. returned: success when state == present - type: string + type: str sample: 47cec963-fcd2-482f-bdb6-24461b2d47b1 ip: description: The floating IP address or network. This is always present and used to identify floating IPs after creation. returned: success - type: string + type: str sample: 185.98.122.176 state: description: The current status of the floating IP. returned: success - type: string + type: str sample: present ''' diff --git a/lib/ansible/modules/cloud/cloudscale/cloudscale_server.py b/lib/ansible/modules/cloud/cloudscale/cloudscale_server.py index 23484b9809..e67167d347 100644 --- a/lib/ansible/modules/cloud/cloudscale/cloudscale_server.py +++ b/lib/ansible/modules/cloud/cloudscale/cloudscale_server.py @@ -152,32 +152,32 @@ RETURN = ''' href: description: API URL to get details about this server returned: success when not state == absent - type: string + type: str sample: https://api.cloudscale.ch/v1/servers/cfde831a-4e87-4a75-960f-89b0148aa2cc uuid: description: The unique identifier for this server returned: success - type: string + type: str sample: cfde831a-4e87-4a75-960f-89b0148aa2cc name: description: The display name of the server returned: success - type: string + type: str sample: its-a-me-mario.cloudscale.ch state: description: The current status of the server returned: success - type: string + type: str sample: running flavor: description: The flavor that has been used for this server returned: success when not state == absent - type: string + type: str sample: flex-8 image: description: The image used for booting this server returned: success when not state == absent - type: string + type: str sample: debian-8 volumes: description: List of volumes attached to the server @@ -202,7 +202,7 @@ ssh_host_keys: anti_affinity_with: description: List of servers in the same anti-affinity group returned: success when not state == absent - type: string + type: str sample: [] ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_account.py b/lib/ansible/modules/cloud/cloudstack/cs_account.py index 9731f5e4df..8dcf0ed06d 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_account.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_account.py @@ -163,37 +163,37 @@ RETURN = ''' id: description: UUID of the account. returned: success - type: string + type: str sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 name: description: Name of the account. returned: success - type: string + type: str sample: linus@example.com account_type: description: Type of the account. returned: success - type: string + type: str sample: user state: description: State of the account. returned: success - type: string + type: str sample: enabled network_domain: description: Network domain of the account. returned: success - type: string + type: str sample: example.local domain: description: Domain the account is related. returned: success - type: string + type: str sample: ROOT role: description: The role name of the account returned: success - type: string + type: str sample: Domain Admin ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py b/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py index f902860770..75067e6572 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py @@ -84,37 +84,37 @@ RETURN = ''' id: description: UUID of the affinity group. returned: success - type: string + type: str sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 name: description: Name of affinity group. returned: success - type: string + type: str sample: app description: description: Description of affinity group. returned: success - type: string + type: str sample: application affinity group affinity_type: description: Type of affinity group. returned: success - type: string + type: str sample: host anti-affinity project: description: Name of project the affinity group is related to. returned: success - type: string + type: str sample: Production domain: description: Domain the affinity group is related to. returned: success - type: string + type: str sample: example domain account: description: Account the affinity group is related to. returned: success - type: string + type: str sample: example account ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_cluster.py b/lib/ansible/modules/cloud/cloudstack/cs_cluster.py index e1da0c38fc..07e158dc98 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_cluster.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_cluster.py @@ -142,57 +142,57 @@ RETURN = ''' id: description: UUID of the cluster. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the cluster. returned: success - type: string + type: str sample: cluster01 allocation_state: description: State of the cluster. returned: success - type: string + type: str sample: Enabled cluster_type: description: Type of the cluster. returned: success - type: string + type: str sample: ExternalManaged cpu_overcommit_ratio: description: The CPU overcommit ratio of the cluster. returned: success - type: string + type: str sample: 1.0 memory_overcommit_ratio: description: The memory overcommit ratio of the cluster. returned: success - type: string + type: str sample: 1.0 managed_state: description: Whether this cluster is managed by CloudStack. returned: success - type: string + type: str sample: Managed ovm3_vip: description: Ovm3 VIP to use for pooling and/or clustering returned: success - type: string + type: str sample: 10.10.10.101 hypervisor: description: Hypervisor of the cluster returned: success - type: string + type: str sample: VMware zone: description: Name of zone the cluster is in. returned: success - type: string + type: str sample: ch-gva-2 pod: description: Name of pod the cluster is in. returned: success - type: string + type: str sample: pod01 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_configuration.py b/lib/ansible/modules/cloud/cloudstack/cs_configuration.py index bcb8e9e168..aad0ae1af5 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_configuration.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_configuration.py @@ -95,52 +95,52 @@ RETURN = ''' category: description: Category of the configuration. returned: success - type: string + type: str sample: Advanced scope: description: Scope (zone/cluster/storagepool/account) of the parameter that needs to be updated. returned: success - type: string + type: str sample: storagepool description: description: Description of the configuration. returned: success - type: string + type: str sample: Setup the host to do multipath name: description: Name of the configuration. returned: success - type: string + type: str sample: zone.vlan.capacity.notificationthreshold value: description: Value of the configuration. returned: success - type: string + type: str sample: "0.75" account: description: Account of the configuration. returned: success - type: string + type: str sample: admin Domain: description: Domain of account of the configuration. returned: success - type: string + type: str sample: ROOT zone: description: Zone of the configuration. returned: success - type: string + type: str sample: ch-gva-01 cluster: description: Cluster of the configuration. returned: success - type: string + type: str sample: cluster01 storage: description: Storage of the configuration. returned: success - type: string + type: str sample: storage01 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_disk_offering.py b/lib/ansible/modules/cloud/cloudstack/cs_disk_offering.py index 68ba5fb498..889866f309 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_disk_offering.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_disk_offering.py @@ -128,7 +128,7 @@ RETURN = ''' id: description: UUID of the disk offering returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f disk_size: description: Size of the disk offering in GB @@ -168,17 +168,17 @@ iops_write_rate: created: description: Date the offering was created returned: success - type: string + type: str sample: 2017-11-19T10:48:59+0000 display_text: description: Display text of the offering returned: success - type: string + type: str sample: Small 10GB domain: description: Domain the offering is into returned: success - type: string + type: str sample: ROOT storage_tags: description: List of storage tags @@ -193,17 +193,17 @@ customized: name: description: Name of the system offering returned: success - type: string + type: str sample: Micro provisioning_type: description: Provisioning type used to create volumes returned: success - type: string + type: str sample: thin storage_type: description: Storage type used to create volumes returned: success - type: string + type: str sample: shared display_offering: description: Whether to display the offering to the end user or not. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_domain.py b/lib/ansible/modules/cloud/cloudstack/cs_domain.py index 15910c46ff..783076b612 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_domain.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_domain.py @@ -85,27 +85,27 @@ RETURN = ''' id: description: UUID of the domain. returned: success - type: string + type: str sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 name: description: Name of the domain. returned: success - type: string + type: str sample: customers path: description: Domain path. returned: success - type: string + type: str sample: /ROOT/customers parent_domain: description: Parent domain of the domain. returned: success - type: string + type: str sample: ROOT network_domain: description: Network domain of the domain. returned: success - type: string + type: str sample: example.local ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_facts.py b/lib/ansible/modules/cloud/cloudstack/cs_facts.py index 3f75e5f700..fe3d1a11f3 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_facts.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_facts.py @@ -73,37 +73,37 @@ RETURN = ''' cloudstack_availability_zone: description: zone the instance is deployed in. returned: success - type: string + type: str sample: ch-gva-2 cloudstack_instance_id: description: UUID of the instance. returned: success - type: string + type: str sample: ab4e80b0-3e7e-4936-bdc5-e334ba5b0139 cloudstack_local_hostname: description: local hostname of the instance. returned: success - type: string + type: str sample: VM-ab4e80b0-3e7e-4936-bdc5-e334ba5b0139 cloudstack_local_ipv4: description: local IPv4 of the instance. returned: success - type: string + type: str sample: 185.19.28.35 cloudstack_public_hostname: description: public IPv4 of the router. Same as C(cloudstack_public_ipv4). returned: success - type: string + type: str sample: VM-ab4e80b0-3e7e-4936-bdc5-e334ba5b0139 cloudstack_public_ipv4: description: public IPv4 of the router. returned: success - type: string + type: str sample: 185.19.28.35 cloudstack_service_offering: description: service offering of the instance. returned: success - type: string + type: str sample: Micro 512mb 1cpu cloudstack_user_data: description: data of the instance provided by users. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_firewall.py b/lib/ansible/modules/cloud/cloudstack/cs_firewall.py index 04841e3c13..aa15d1c27f 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_firewall.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_firewall.py @@ -141,22 +141,22 @@ RETURN = ''' id: description: UUID of the rule. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 ip_address: description: IP address of the rule if C(type=ingress) returned: success - type: string + type: str sample: 10.100.212.10 type: description: Type of the rule. returned: success - type: string + type: str sample: ingress cidr: description: CIDR string of the rule. returned: success - type: string + type: str sample: 0.0.0.0/0 cidrs: description: CIDR list of the rule. @@ -167,7 +167,7 @@ cidrs: protocol: description: Protocol of the rule. returned: success - type: string + type: str sample: tcp start_port: description: Start port of the rule. @@ -192,7 +192,7 @@ icmp_type: network: description: Name of the network if C(type=egress) returned: success - type: string + type: str sample: my_network ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_host.py b/lib/ansible/modules/cloud/cloudstack/cs_host.py index 29c5717dee..49d49122cf 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_host.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_host.py @@ -123,27 +123,27 @@ RETURN = ''' capabilities: description: Capabilities of the host. returned: success - type: string + type: str sample: hvm cluster: description: Cluster of the host. returned: success - type: string + type: str sample: vcenter.example.com/zone/cluster01 cluster_type: description: Type of the cluster of the host. returned: success - type: string + type: str sample: ExternalManaged cpu_allocated: description: Amount in percent of the host's CPU currently allocated. returned: success - type: string + type: str sample: 166.25% cpu_number: description: Number of CPUs of the host. returned: success - type: string + type: str sample: 24 cpu_sockets: description: Number of CPU sockets of the host. @@ -158,22 +158,22 @@ cpu_speed: cpu_used: description: Amount of the host's CPU currently used. returned: success - type: string + type: str sample: 33.6% cpu_with_overprovisioning: description: Amount of the host's CPU after applying the cpu.overprovisioning.factor. returned: success - type: string + type: str sample: 959520.0 created: description: Date when the host was created. returned: success - type: string + type: str sample: 2015-05-03T15:05:51+0200 disconnected: description: Date when the host was disconnected. returned: success - type: string + type: str sample: 2015-05-03T15:05:51+0200 disk_size_allocated: description: Host's currently allocated disk size. @@ -188,7 +188,7 @@ disk_size_total: events: description: Events available for the host returned: success - type: string + type: str sample: "Ping; HostDown; AgentConnected; AgentDisconnected; PingTimeout; ShutdownRequested; Remove; StartAgentRebalance; ManagementServerDown" ha_host: description: Whether the host is a HA host. @@ -203,22 +203,22 @@ has_enough_capacity: host_tags: description: Comma-separated list of tags for the host. returned: success - type: string + type: str sample: "perf" hypervisor: description: Host's hypervisor. returned: success - type: string + type: str sample: VMware hypervisor_version: description: Hypervisor version. returned: success - type: string + type: str sample: 5.1 ip_address: description: IP address of the host returned: success - type: string + type: str sample: 10.10.10.1 is_local_storage_active: description: Whether the local storage is available or not. @@ -228,7 +228,7 @@ is_local_storage_active: last_pinged: description: Date and time the host was last pinged. returned: success - type: string + type: str sample: "1970-01-17T17:27:32+0100" management_server_id: description: Management server ID of the host. @@ -253,7 +253,7 @@ memory_used: name: description: Name of the host. returned: success - type: string + type: str sample: esx32.example.com network_kbs_read: description: Incoming network traffic on the host. @@ -268,53 +268,53 @@ network_kbs_write: os_category: description: OS category name of the host. returned: success - type: string + type: str sample: ... out_of_band_management: description: Host out-of-band management information. returned: success - type: string + type: str sample: ... pod: description: Pod name of the host. returned: success - type: string + type: str sample: Pod01 removed: description: Date and time the host was removed. returned: success - type: string + type: str sample: "1970-01-17T17:27:32+0100" resource_state: description: Resource state of the host. returned: success - type: string + type: str sample: Enabled allocation_state:: description: Allocation state of the host. returned: success - type: string + type: str sample: enabled state: description: State of the host. returned: success - type: string + type: str sample: Up suitable_for_migration: description: Whether this host is suitable (has enough capacity and satisfies all conditions like hosttags, max guests VM limit, etc) to migrate a VM to it or not. returned: success - type: string + type: str sample: true host_type: description: Type of the host. returned: success - type: string + type: str sample: Routing host_version: description: Version of the host. returned: success - type: string + type: str sample: 4.5.2 gpu_group: description: GPU cards present in the host. @@ -324,7 +324,7 @@ gpu_group: zone: description: Zone of the host. returned: success - type: string + type: str sample: zone01 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instance.py b/lib/ansible/modules/cloud/cloudstack/cs_instance.py index ee17cfb317..1b259c5784 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instance.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instance.py @@ -251,104 +251,104 @@ RETURN = ''' id: description: UUID of the instance. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the instance. returned: success - type: string + type: str sample: web-01 display_name: description: Display name of the instance. returned: success - type: string + type: str sample: web-01 group: description: Group name of the instance is related. returned: success - type: string + type: str sample: web created: description: Date of the instance was created. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 password_enabled: description: True if password setting is enabled. returned: success - type: boolean + type: bool sample: true password: description: The password of the instance if exists. returned: success - type: string + type: str sample: Ge2oe7Do ssh_key: description: Name of SSH key deployed to instance. returned: success - type: string + type: str sample: key@work domain: description: Domain the instance is related to. returned: success - type: string + type: str sample: example domain account: description: Account the instance is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the instance is related to. returned: success - type: string + type: str sample: Production default_ip: description: Default IP address of the instance. returned: success - type: string + type: str sample: 10.23.37.42 default_ip6: description: Default IPv6 address of the instance. returned: success - type: string + type: str sample: 2a04:c43:c00:a07:4b4:beff:fe00:74 version_added: '2.6' public_ip: description: Public IP address with instance via static NAT rule. returned: success - type: string + type: str sample: 1.2.3.4 iso: description: Name of ISO the instance was deployed with. returned: success - type: string + type: str sample: Debian-8-64bit template: description: Name of template the instance was deployed with. returned: success - type: string + type: str sample: Linux Debian 9 64-bit template_display_text: description: Display text of template the instance was deployed with. returned: success - type: string + type: str sample: Linux Debian 9 64-bit 200G Disk (2017-10-08-622866) version_added: 2.6 service_offering: description: Name of the service offering the instance has. returned: success - type: string + type: str sample: 2cpu_2gb zone: description: Name of zone the instance is in. returned: success - type: string + type: str sample: ch-gva-2 state: description: State of the instance. returned: success - type: string + type: str sample: Running security_groups: description: Security groups the instance is in. @@ -368,18 +368,18 @@ tags: hypervisor: description: Hypervisor related to this instance. returned: success - type: string + type: str sample: KVM host: description: Hostname of hypervisor an instance is running on. returned: success and instance is running - type: string + type: str sample: host-01.example.com version_added: 2.6 instance_name: description: Internal name of the instance (ROOT admin only). returned: success - type: string + type: str sample: i-44-3992-VM ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instance_facts.py b/lib/ansible/modules/cloud/cloudstack/cs_instance_facts.py index 3ba32198b9..d07cb048c4 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instance_facts.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instance_facts.py @@ -57,92 +57,92 @@ RETURN = ''' id: description: UUID of the instance. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the instance. returned: success - type: string + type: str sample: web-01 display_name: description: Display name of the instance. returned: success - type: string + type: str sample: web-01 group: description: Group name of the instance is related. returned: success - type: string + type: str sample: web created: description: Date of the instance was created. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 password_enabled: description: True if password setting is enabled. returned: success - type: boolean + type: bool sample: true password: description: The password of the instance if exists. returned: success - type: string + type: str sample: Ge2oe7Do ssh_key: description: Name of SSH key deployed to instance. returned: success - type: string + type: str sample: key@work domain: description: Domain the instance is related to. returned: success - type: string + type: str sample: example domain account: description: Account the instance is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the instance is related to. returned: success - type: string + type: str sample: Production default_ip: description: Default IP address of the instance. returned: success - type: string + type: str sample: 10.23.37.42 public_ip: description: Public IP address with instance via static NAT rule. returned: success - type: string + type: str sample: 1.2.3.4 iso: description: Name of ISO the instance was deployed with. returned: success - type: string + type: str sample: Debian-8-64bit template: description: Name of template the instance was deployed with. returned: success - type: string + type: str sample: Debian-8-64bit service_offering: description: Name of the service offering the instance has. returned: success - type: string + type: str sample: 2cpu_2gb zone: description: Name of zone the instance is in. returned: success - type: string + type: str sample: ch-gva-2 state: description: State of the instance. returned: success - type: string + type: str sample: Running security_groups: description: Security groups the instance is in. @@ -162,18 +162,18 @@ tags: hypervisor: description: Hypervisor related to this instance. returned: success - type: string + type: str sample: KVM host: description: Host the instance is running on. returned: success and instance is running - type: string + type: str sample: host01.example.com version_added: '2.6' instance_name: description: Internal name of the instance (ROOT admin only). returned: success - type: string + type: str sample: i-44-3992-VM volumes: description: List of dictionaries of the volumes attached to the instance. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py b/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py index ec53513e04..1f2e2e1c9f 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py @@ -103,47 +103,47 @@ RETURN = ''' id: description: UUID of the nic. returned: success - type: string + type: str sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 vm: description: Name of the VM. returned: success - type: string + type: str sample: web-01 ip_address: description: Primary IP of the NIC. returned: success - type: string + type: str sample: 10.10.10.10 netmask: description: Netmask of the NIC. returned: success - type: string + type: str sample: 255.255.255.0 mac_address: description: MAC address of the NIC. returned: success - type: string + type: str sample: 02:00:33:31:00:e4 network: description: Name of the network if not default. returned: success - type: string + type: str sample: sync network domain: description: Domain the VM is related to. returned: success - type: string + type: str sample: example domain account: description: Account the VM is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the VM is related to. returned: success - type: string + type: str sample: Production ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py b/lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py index 0b77657e04..1983e0316d 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py @@ -101,52 +101,52 @@ RETURN = ''' id: description: UUID of the NIC. returned: success - type: string + type: str sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 vm: description: Name of the VM. returned: success - type: string + type: str sample: web-01 ip_address: description: Primary IP of the NIC. returned: success - type: string + type: str sample: 10.10.10.10 netmask: description: Netmask of the NIC. returned: success - type: string + type: str sample: 255.255.255.0 mac_address: description: MAC address of the NIC. returned: success - type: string + type: str sample: 02:00:33:31:00:e4 vm_guest_ip: description: Secondary IP of the NIC. returned: success - type: string + type: str sample: 10.10.10.10 network: description: Name of the network if not default. returned: success - type: string + type: str sample: sync network domain: description: Domain the VM is related to. returned: success - type: string + type: str sample: example domain account: description: Account the VM is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the VM is related to. returned: success - type: string + type: str sample: Production ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instance_password_reset.py b/lib/ansible/modules/cloud/cloudstack/cs_instance_password_reset.py index 6691b3d168..b9abfac534 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instance_password_reset.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instance_password_reset.py @@ -90,12 +90,12 @@ RETURN = ''' id: description: ID of the virtual machine. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f password: description: The new default password. returned: success - type: string + type: str sample: ahQu5nuNge3keesh ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py b/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py index 7709f42d45..e74fb18f08 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py @@ -71,32 +71,32 @@ RETURN = ''' id: description: UUID of the instance group. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the instance group. returned: success - type: string + type: str sample: webservers created: description: Date when the instance group was created. returned: success - type: string + type: str sample: 2015-05-03T15:05:51+0200 domain: description: Domain the instance group is related to. returned: success - type: string + type: str sample: example domain account: description: Account the instance group is related to. returned: success - type: string + type: str sample: example account project: description: Project the instance group is related to. returned: success - type: string + type: str sample: example project ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py b/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py index 0c3c90e954..14706a99bf 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_ip_address.py @@ -107,32 +107,32 @@ RETURN = ''' id: description: UUID of the Public IP address. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f ip_address: description: Public IP address. returned: success - type: string + type: str sample: 1.2.3.4 zone: description: Name of zone the IP address is related to. returned: success - type: string + type: str sample: ch-gva-2 project: description: Name of project the IP address is related to. returned: success - type: string + type: str sample: Production account: description: Account the IP address is related to. returned: success - type: string + type: str sample: example account domain: description: Domain the IP address is related to. returned: success - type: string + type: str sample: example domain tags: description: List of resource tags associated with the IP address. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_iso.py b/lib/ansible/modules/cloud/cloudstack/cs_iso.py index 53248539fe..430dec2ad0 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_iso.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_iso.py @@ -151,93 +151,93 @@ RETURN = ''' id: description: UUID of the ISO. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: Name of the ISO. returned: success - type: string + type: str sample: Debian 7 64-bit display_text: description: Text to be displayed of the ISO. returned: success - type: string + type: str sample: Debian 7.7 64-bit minimal 2015-03-19 zone: description: Name of zone the ISO is registered in. returned: success - type: string + type: str sample: zuerich status: description: Status of the ISO. returned: success - type: string + type: str sample: Successfully Installed is_ready: description: True if the ISO is ready to be deployed from. returned: success - type: boolean + type: bool sample: true is_public: description: True if the ISO is public. returned: success - type: boolean + type: bool sample: true version_added: "2.4" bootable: description: True if the ISO is bootable. returned: success - type: boolean + type: bool sample: true version_added: "2.4" is_featured: description: True if the ISO is featured. returned: success - type: boolean + type: bool sample: true version_added: "2.4" format: description: Format of the ISO. returned: success - type: string + type: str sample: ISO version_added: "2.4" os_type: description: Typo of the OS. returned: success - type: string + type: str sample: CentOS 6.5 (64-bit) version_added: "2.4" checksum: description: MD5 checksum of the ISO. returned: success - type: string + type: str sample: 0b31bccccb048d20b551f70830bb7ad0 created: description: Date of registering. returned: success - type: string + type: str sample: 2015-03-29T14:57:06+0200 cross_zones: description: true if the ISO is managed across all zones, false otherwise. returned: success - type: boolean + type: bool sample: false version_added: "2.4" domain: description: Domain the ISO is related to. returned: success - type: string + type: str sample: example domain account: description: Account the ISO is related to. returned: success - type: string + type: str sample: example account project: description: Project the ISO is related to. returned: success - type: string + type: str sample: example project tags: description: List of resource tags associated with the ISO. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py index 240e9fc496..3e3a36ce96 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py @@ -129,67 +129,67 @@ RETURN = ''' id: description: UUID of the rule. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f zone: description: Name of zone the rule is related to. returned: success - type: string + type: str sample: ch-gva-2 project: description: Name of project the rule is related to. returned: success - type: string + type: str sample: Production account: description: Account the rule is related to. returned: success - type: string + type: str sample: example account domain: description: Domain the rule is related to. returned: success - type: string + type: str sample: example domain algorithm: description: Load balancer algorithm used. returned: success - type: string + type: str sample: "source" cidr: description: CIDR to forward traffic from. returned: success - type: string + type: str sample: "" name: description: Name of the rule. returned: success - type: string + type: str sample: "http-lb" description: description: Description of the rule. returned: success - type: string + type: str sample: "http load balancer rule" protocol: description: Protocol of the rule. returned: success - type: string + type: str sample: "tcp" public_port: description: Public port. returned: success - type: string + type: str sample: 80 private_port: description: Private IP address. returned: success - type: string + type: str sample: 80 public_ip: description: Public IP address. returned: success - type: string + type: str sample: "1.2.3.4" tags: description: List of resource tags associated with the rule. @@ -199,7 +199,7 @@ tags: state: description: State of the rule. returned: success - type: string + type: str sample: "Add" ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py index ccbacbc9fe..02b72763eb 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py @@ -105,67 +105,67 @@ RETURN = ''' id: description: UUID of the rule. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f zone: description: Name of zone the rule is related to. returned: success - type: string + type: str sample: ch-gva-2 project: description: Name of project the rule is related to. returned: success - type: string + type: str sample: Production account: description: Account the rule is related to. returned: success - type: string + type: str sample: example account domain: description: Domain the rule is related to. returned: success - type: string + type: str sample: example domain algorithm: description: Load balancer algorithm used. returned: success - type: string + type: str sample: "source" cidr: description: CIDR to forward traffic from. returned: success - type: string + type: str sample: "" name: description: Name of the rule. returned: success - type: string + type: str sample: "http-lb" description: description: Description of the rule. returned: success - type: string + type: str sample: "http load balancer rule" protocol: description: Protocol of the rule. returned: success - type: string + type: str sample: "tcp" public_port: description: Public port. returned: success - type: string + type: str sample: 80 private_port: description: Private IP address. returned: success - type: string + type: str sample: 80 public_ip: description: Public IP address. returned: success - type: string + type: str sample: "1.2.3.4" vms: description: Rule members. @@ -180,7 +180,7 @@ tags: state: description: State of the rule. returned: success - type: string + type: str sample: "Add" ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_network.py b/lib/ansible/modules/cloud/cloudstack/cs_network.py index b3e64424d6..9de87fd668 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_network.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_network.py @@ -175,72 +175,72 @@ RETURN = ''' id: description: UUID of the network. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the network. returned: success - type: string + type: str sample: web project display_text: description: Display text of the network. returned: success - type: string + type: str sample: web project dns1: description: IP address of the 1st nameserver. returned: success - type: string + type: str sample: 1.2.3.4 dns2: description: IP address of the 2nd nameserver. returned: success - type: string + type: str sample: 1.2.3.4 cidr: description: IPv4 network CIDR. returned: success - type: string + type: str sample: 10.101.64.0/24 gateway: description: IPv4 gateway. returned: success - type: string + type: str sample: 10.101.64.1 netmask: description: IPv4 netmask. returned: success - type: string + type: str sample: 255.255.255.0 cidr_ipv6: description: IPv6 network CIDR. returned: success - type: string + type: str sample: 2001:db8::/64 gateway_ipv6: description: IPv6 gateway. returned: success - type: string + type: str sample: 2001:db8::1 zone: description: Name of zone. returned: success - type: string + type: str sample: ch-gva-2 domain: description: Domain the network is related to. returned: success - type: string + type: str sample: ROOT account: description: Account the network is related to. returned: success - type: string + type: str sample: example account project: description: Name of project. returned: success - type: string + type: str sample: Production tags: description: List of resource tags associated with the network. @@ -250,59 +250,59 @@ tags: acl_type: description: Access type of the VPC network tier (Domain, Account). returned: success - type: string + type: str sample: Account acl: description: Name of the access control list for the VPC network tier. returned: success - type: string + type: str sample: My ACL version_added: "2.5" acl_id: description: ID of the access control list for the VPC network tier. returned: success - type: string + type: str sample: dfafcd55-0510-4b8c-b6c5-b8cedb4cfd88 version_added: "2.5" broadcast_domain_type: description: Broadcast domain type of the network. returned: success - type: string + type: str sample: Vlan type: description: Type of the network. returned: success - type: string + type: str sample: Isolated traffic_type: description: Traffic type of the network. returned: success - type: string + type: str sample: Guest state: description: State of the network (Allocated, Implemented, Setup). returned: success - type: string + type: str sample: Allocated is_persistent: description: Whether the network is persistent or not. returned: success - type: boolean + type: bool sample: false network_domain: description: The network domain returned: success - type: string + type: str sample: example.local network_offering: description: The network offering name. returned: success - type: string + type: str sample: DefaultIsolatedNetworkOfferingWithSourceNatService network_offering_display_text: description: The network offering display text. returned: success - type: string + type: str sample: Offering for Isolated Vpc networks with Source Nat service enabled version_added: "2.5" network_offering_conserve_mode: @@ -314,7 +314,7 @@ network_offering_conserve_mode: network_offering_availability: description: The availability of the network offering the network is created from returned: success - type: string + type: str sample: Optional version_added: "2.5" is_system: diff --git a/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py b/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py index 5c069208c5..52ac9d0c9f 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_network_acl.py @@ -90,22 +90,22 @@ RETURN = ''' name: description: Name of the network ACL. returned: success - type: string + type: str sample: customer acl description: description: Description of the network ACL. returned: success - type: string + type: str sample: Example description of a network ACL vpc: description: VPC of the network ACL. returned: success - type: string + type: str sample: customer vpc zone: description: Zone the VPC is related to. returned: success - type: string + type: str sample: ch-gva-2 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py b/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py index 5ac1b5b771..693580e9d2 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py @@ -154,12 +154,12 @@ RETURN = ''' network_acl: description: Name of the network ACL. returned: success - type: string + type: str sample: customer acl cidr: description: CIDR of the network ACL rule. returned: success - type: string + type: str sample: 0.0.0.0/0 rule_position: description: Position of the network ACL rule. @@ -169,17 +169,17 @@ rule_position: action_policy: description: Action policy of the network ACL rule. returned: success - type: string + type: str sample: deny traffic_type: description: Traffic type of the network ACL rule. returned: success - type: string + type: str sample: ingress protocol: description: Protocol of the network ACL rule. returned: success - type: string + type: str sample: tcp protocol_number: description: Protocol number in case protocol is by number. @@ -209,12 +209,12 @@ icmp_type: state: description: State of the network ACL rule. returned: success - type: string + type: str sample: Active vpc: description: VPC of the network ACL. returned: success - type: string + type: str sample: customer vpc tags: description: List of resource tags associated with the network ACL rule. @@ -224,22 +224,22 @@ tags: domain: description: Domain the network ACL rule is related to. returned: success - type: string + type: str sample: example domain account: description: Account the network ACL rule is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the network ACL rule is related to. returned: success - type: string + type: str sample: Production zone: description: Zone the VPC is related to. returned: success - type: string + type: str sample: ch-gva-2 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_network_offering.py b/lib/ansible/modules/cloud/cloudstack/cs_network_offering.py index 9f8d94bfc2..b2f0cee1a8 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_network_offering.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_network_offering.py @@ -127,37 +127,37 @@ RETURN = ''' id: description: UUID of the network offering. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: The name of the network offering. returned: success - type: string + type: str sample: MyCustomNetworkOffering display_text: description: The display text of the network offering. returned: success - type: string + type: str sample: My network offering state: description: The state of the network offering. returned: success - type: string + type: str sample: Enabled guest_ip_type: description: Guest type of the network offering. returned: success - type: string + type: str sample: Isolated availability: description: The availability of network offering. returned: success - type: string + type: str sample: Optional service_offering_id: description: The service offering ID. returned: success - type: string + type: str sample: c5f7a5fc-43f8-11e5-a151-feff819cdc9f max_connections: description: The maximum number of concurrents connections to be handled by LB. @@ -172,12 +172,12 @@ network_rate: traffic_type: description: The traffic type. returned: success - type: string + type: str sample: Guest egress_default_policy: description: Default egress policy. returned: success - type: string + type: str sample: allow is_persistent: description: Whether persistent networks are supported or not. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_pod.py b/lib/ansible/modules/cloud/cloudstack/cs_pod.py index fc7503b8cc..9ca87cb27c 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_pod.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_pod.py @@ -90,42 +90,42 @@ RETURN = ''' id: description: UUID of the pod. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the pod. returned: success - type: string + type: str sample: pod01 start_ip: description: Starting IP of the pod. returned: success - type: string + type: str sample: 10.100.1.101 end_ip: description: Ending IP of the pod. returned: success - type: string + type: str sample: 10.100.1.254 netmask: description: Netmask of the pod. returned: success - type: string + type: str sample: 255.255.255.0 gateway: description: Gateway of the pod. returned: success - type: string + type: str sample: 10.100.1.1 allocation_state: description: State of the pod. returned: success - type: string + type: str sample: Enabled zone: description: Name of zone the pod is in. returned: success - type: string + type: str sample: ch-gva-2 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_portforward.py b/lib/ansible/modules/cloud/cloudstack/cs_portforward.py index d88488d546..48b484f9b7 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_portforward.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_portforward.py @@ -142,17 +142,17 @@ RETURN = ''' id: description: UUID of the public IP address. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f ip_address: description: Public IP address. returned: success - type: string + type: str sample: 1.2.3.4 protocol: description: Protocol. returned: success - type: string + type: str sample: tcp private_port: description: Start port on the virtual machine's IP address. @@ -181,27 +181,27 @@ tags: vm_name: description: Name of the virtual machine. returned: success - type: string + type: str sample: web-01 vm_display_name: description: Display name of the virtual machine. returned: success - type: string + type: str sample: web-01 vm_guest_ip: description: IP of the virtual machine. returned: success - type: string + type: str sample: 10.101.65.152 vpc: description: Name of the VPC. returned: success - type: string + type: str sample: my_vpc network: description: Name of the network. returned: success - type: string + type: str sample: dmz ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_project.py b/lib/ansible/modules/cloud/cloudstack/cs_project.py index c195324b2f..f059c1a565 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_project.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_project.py @@ -103,32 +103,32 @@ RETURN = ''' id: description: UUID of the project. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the project. returned: success - type: string + type: str sample: web project display_text: description: Display text of the project. returned: success - type: string + type: str sample: web project state: description: State of the project. returned: success - type: string + type: str sample: Active domain: description: Domain the project is related to. returned: success - type: string + type: str sample: example domain account: description: Account the project is related to. returned: success - type: string + type: str sample: example account tags: description: List of resource tags associated with the project. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_region.py b/lib/ansible/modules/cloud/cloudstack/cs_region.py index dd79d27524..c8db4bc380 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_region.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_region.py @@ -78,12 +78,12 @@ id: name: description: Name of the region. returned: success - type: string + type: str sample: local endpoint: description: Endpoint of the region. returned: success - type: string + type: str sample: http://cloud.example.com gslb_service_enabled: description: Whether the GSLB service is enabled or not. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py b/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py index ac1d130210..1792af80b9 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py @@ -75,7 +75,7 @@ RETURN = ''' recource_type: description: Type of the resource returned: success - type: string + type: str sample: instance limit: description: Maximum number of the resource. @@ -85,17 +85,17 @@ limit: domain: description: Domain the resource is related to. returned: success - type: string + type: str sample: example domain account: description: Account the resource is related to. returned: success - type: string + type: str sample: example account project: description: Project the resource is related to. returned: success - type: string + type: str sample: example project ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_role.py b/lib/ansible/modules/cloud/cloudstack/cs_role.py index 8630a0679b..8d4e33ead3 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_role.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_role.py @@ -82,22 +82,22 @@ RETURN = ''' id: description: UUID of the role. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the role. returned: success - type: string + type: str sample: myrole description: description: Description of the role. returned: success - type: string + type: str sample: "This is my role description" role_type: description: Type of the role. returned: success - type: string + type: str sample: User ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_role_permission.py b/lib/ansible/modules/cloud/cloudstack/cs_role_permission.py index a7be8cbf38..6862ecfc7c 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_role_permission.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_role_permission.py @@ -81,27 +81,27 @@ RETURN = ''' id: description: The ID of the role permission. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: The API name of the permission. returned: success - type: string + type: str sample: createVPC permission: description: The permission type of the api name. returned: success - type: string + type: str sample: allow role_id: description: The ID of the role to which the role permission belongs. returned: success - type: string + type: str sample: c6f7a5fc-43f8-11e5-a151-feff819cdc7f description: description: The description of the role permission returned: success - type: string + type: str sample: Deny createVPC for users ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_router.py b/lib/ansible/modules/cloud/cloudstack/cs_router.py index cb657a9661..fd7bf79d91 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_router.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_router.py @@ -107,22 +107,22 @@ RETURN = ''' id: description: UUID of the router. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the router. returned: success - type: string + type: str sample: r-40-VM created: description: Date of the router was created. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 template_version: description: Version of the system VM template. returned: success - type: string + type: str sample: 4.5.1 requires_upgrade: description: Whether the router needs to be upgraded to the new template. @@ -132,37 +132,37 @@ requires_upgrade: redundant_state: description: Redundant state of the router. returned: success - type: string + type: str sample: UNKNOWN role: description: Role of the router. returned: success - type: string + type: str sample: VIRTUAL_ROUTER zone: description: Name of zone the router is in. returned: success - type: string + type: str sample: ch-gva-2 service_offering: description: Name of the service offering the router has. returned: success - type: string + type: str sample: System Offering For Software Router state: description: State of the router. returned: success - type: string + type: str sample: Active domain: description: Domain the router is related to. returned: success - type: string + type: str sample: ROOT account: description: Account the router is related to. returned: success - type: string + type: str sample: admin ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py b/lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py index dc03614387..a6625a172e 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py @@ -65,17 +65,17 @@ RETURN = ''' id: description: UUID of the security group. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: Name of security group. returned: success - type: string + type: str sample: app description: description: Description of security group. returned: success - type: string + type: str sample: application security group tags: description: List of resource tags associated with the security group. @@ -85,17 +85,17 @@ tags: project: description: Name of project the security group is related to. returned: success - type: string + type: str sample: Production domain: description: Domain the security group is related to. returned: success - type: string + type: str sample: example domain account: description: Account the security group is related to. returned: success - type: string + type: str sample: example account ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py b/lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py index 508dc90844..7599408c87 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py @@ -121,32 +121,32 @@ RETURN = ''' id: description: UUID of the of the rule. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f security_group: description: security group of the rule. returned: success - type: string + type: str sample: default type: description: type of the rule. returned: success - type: string + type: str sample: ingress cidr: description: CIDR of the rule. returned: success and cidr is defined - type: string + type: str sample: 0.0.0.0/0 user_security_group: description: user security group of the rule. returned: success and user_security_group is defined - type: string + type: str sample: default protocol: description: protocol of the rule. returned: success - type: string + type: str sample: tcp start_port: description: start port of the rule. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_service_offering.py b/lib/ansible/modules/cloud/cloudstack/cs_service_offering.py index 8231de356f..35767f4c83 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_service_offering.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_service_offering.py @@ -210,7 +210,7 @@ RETURN = ''' id: description: UUID of the service offering returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f cpu_number: description: Number of CPUs in the service offering @@ -255,17 +255,17 @@ disk_iops_write_rate: created: description: Date the offering was created returned: success - type: string + type: str sample: 2017-11-19T10:48:59+0000 display_text: description: Display text of the offering returned: success - type: string + type: str sample: Micro 512mb 1cpu domain: description: Domain the offering is into returned: success - type: string + type: str sample: ROOT host_tags: description: List of host tags @@ -305,7 +305,7 @@ memory: name: description: Name of the system offering returned: success - type: string + type: str sample: Micro offer_ha: description: Whether HA support is enabled in the offering or not @@ -315,17 +315,17 @@ offer_ha: provisioning_type: description: Provisioning type used to create volumes returned: success - type: string + type: str sample: thin storage_type: description: Storage type used to create volumes returned: success - type: string + type: str sample: shared system_vm_type: description: System VM type of this offering returned: success - type: string + type: str sample: consoleproxy service_offering_details: description: Additioanl service offering details diff --git a/lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py b/lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py index 924a6ea3bf..d082f3b954 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py @@ -135,17 +135,17 @@ RETURN = ''' id: description: UUID of the snapshot policy. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f interval_type: description: interval type of the snapshot policy. returned: success - type: string + type: str sample: daily schedule: description: schedule of the snapshot policy. returned: success - type: string + type: str sample: max_snaps: description: maximum number of snapshots retained. @@ -155,32 +155,32 @@ max_snaps: time_zone: description: the time zone of the snapshot policy. returned: success - type: string + type: str sample: Etc/UTC volume: description: the volume of the snapshot policy. returned: success - type: string + type: str sample: Etc/UTC zone: description: Name of zone the volume is related to. returned: success - type: string + type: str sample: ch-gva-2 project: description: Name of project the volume is related to. returned: success - type: string + type: str sample: Production account: description: Account the volume is related to. returned: success - type: string + type: str sample: example account domain: description: Domain the volume is related to. returned: success - type: string + type: str sample: example domain ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py b/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py index e0ca534930..8c163a9ec1 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py @@ -85,22 +85,22 @@ RETURN = ''' id: description: UUID of the SSH public key. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: Name of the SSH public key. returned: success - type: string + type: str sample: linus@example.com fingerprint: description: Fingerprint of the SSH public key. returned: success - type: string + type: str sample: "86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28" private_key: description: Private key of generated SSH keypair. returned: changed - type: string + type: str sample: "-----BEGIN RSA PRIVATE KEY-----\nMII...8tO\n-----END RSA PRIVATE KEY-----\n" ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py b/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py index 59a93d11a8..dec3f8398a 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_staticnat.py @@ -82,47 +82,47 @@ RETURN = ''' id: description: UUID of the ip_address. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f ip_address: description: Public IP address. returned: success - type: string + type: str sample: 1.2.3.4 vm_name: description: Name of the virtual machine. returned: success - type: string + type: str sample: web-01 vm_display_name: description: Display name of the virtual machine. returned: success - type: string + type: str sample: web-01 vm_guest_ip: description: IP of the virtual machine. returned: success - type: string + type: str sample: 10.101.65.152 zone: description: Name of zone the static NAT is related to. returned: success - type: string + type: str sample: ch-gva-2 project: description: Name of project the static NAT is related to. returned: success - type: string + type: str sample: Production account: description: Account the static NAT is related to. returned: success - type: string + type: str sample: example account domain: description: Domain the static NAT is related to. returned: success - type: string + type: str sample: example domain ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py b/lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py index 4e94b0a625..ff22fac994 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py @@ -139,12 +139,12 @@ RETURN = ''' id: description: UUID of the pool. returned: success - type: string + type: str sample: a3fca65a-7db1-4891-b97c-48806a978a96 created: description: Date of the pool was created. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 capacity_iops: description: IOPS CloudStack can provision from this storage pool @@ -154,17 +154,17 @@ capacity_iops: zone: description: The name of the zone. returned: success - type: string + type: str sample: Zone01 cluster: description: The name of the cluster. returned: when scope is cluster - type: string + type: str sample: Cluster01 pod: description: The name of the pod. returned: when scope is cluster - type: string + type: str sample: Cluster01 disk_size_allocated: description: The pool's currently allocated disk space. @@ -184,32 +184,32 @@ disk_size_used: scope: description: The scope of the storage pool. returned: success - type: string + type: str sample: cluster hypervisor: description: Hypervisor related to this storage pool. returned: when available - type: string + type: str sample: KVM state: description: The state of the storage pool as returned by the API. returned: success - type: string + type: str sample: Up allocation_state: description: The state of the storage pool. returned: success - type: string + type: str sample: enabled path: description: The storage pool path used in the storage_url. returned: success - type: string + type: str sample: poolname overprovision_factor: description: The overprovision factor of the storage pool. returned: success - type: string + type: str sample: 2.0 suitable_for_migration: description: Whether the storage pool is suitable to migrate a volume or not. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_template.py b/lib/ansible/modules/cloud/cloudstack/cs_template.py index efbbed0e1f..44a5c1b149 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_template.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_template.py @@ -245,107 +245,107 @@ RETURN = ''' id: description: UUID of the template or extracted object. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: Name of the template or extracted object. returned: success - type: string + type: str sample: Debian 7 64-bit display_text: description: Display text of the template. returned: if available - type: string + type: str sample: Debian 7.7 64-bit minimal 2015-03-19 checksum: description: MD5 checksum of the template. returned: if available - type: string + type: str sample: 0b31bccccb048d20b551f70830bb7ad0 status: description: Status of the template or extracted object. returned: success - type: string + type: str sample: Download Complete is_ready: description: True if the template is ready to be deployed from. returned: if available - type: boolean + type: bool sample: true is_public: description: True if the template is public. returned: if available - type: boolean + type: bool sample: true is_featured: description: True if the template is featured. returned: if available - type: boolean + type: bool sample: true is_extractable: description: True if the template is extractable. returned: if available - type: boolean + type: bool sample: true format: description: Format of the template. returned: if available - type: string + type: str sample: OVA os_type: description: Type of the OS. returned: if available - type: string + type: str sample: CentOS 6.5 (64-bit) password_enabled: description: True if the reset password feature is enabled, false otherwise. returned: if available - type: boolean + type: bool sample: false sshkey_enabled: description: true if template is sshkey enabled, false otherwise. returned: if available - type: boolean + type: bool sample: false cross_zones: description: true if the template is managed across all zones, false otherwise. returned: if available - type: boolean + type: bool sample: false template_type: description: Type of the template. returned: if available - type: string + type: str sample: USER created: description: Date of registering. returned: success - type: string + type: str sample: 2015-03-29T14:57:06+0200 template_tag: description: Template tag related to this template. returned: if available - type: string + type: str sample: special hypervisor: description: Hypervisor related to this template. returned: if available - type: string + type: str sample: VMware mode: description: Mode of extraction returned: on state=extracted - type: string + type: str sample: http_download state: description: State of the extracted template returned: on state=extracted - type: string + type: str sample: DOWNLOAD_URL_CREATED url: description: Url to which the template is extracted to returned: on state=extracted - type: string + type: str sample: "http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova" tags: description: List of resource tags associated with the template. @@ -355,22 +355,22 @@ tags: zone: description: Name of zone the template is registered in. returned: success - type: string + type: str sample: zuerich domain: description: Domain the template is related to. returned: success - type: string + type: str sample: example domain account: description: Account the template is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the template is related to. returned: success - type: string + type: str sample: Production ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_user.py b/lib/ansible/modules/cloud/cloudstack/cs_user.py index fecccf1a43..9081eb0a3e 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_user.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_user.py @@ -118,67 +118,67 @@ RETURN = ''' id: description: UUID of the user. returned: success - type: string + type: str sample: 87b1e0ce-4e01-11e4-bb66-0050569e64b8 username: description: Username of the user. returned: success - type: string + type: str sample: johndoe fist_name: description: First name of the user. returned: success - type: string + type: str sample: John last_name: description: Last name of the user. returned: success - type: string + type: str sample: Doe email: description: Emailof the user. returned: success - type: string + type: str sample: john.doe@example.com user_api_key: description: API key of the user. returned: success - type: string + type: str sample: JLhcg8VWi8DoFqL2sSLZMXmGojcLnFrOBTipvBHJjySODcV4mCOo29W2duzPv5cALaZnXj5QxDx3xQfaQt3DKg user_api_secret: description: API secret of the user. returned: success - type: string + type: str sample: FUELo3LB9fa1UopjTLPdqLv_6OXQMJZv9g9N4B_Ao3HFz8d6IGFCV9MbPFNM8mwz00wbMevja1DoUNDvI8C9-g account: description: Account name of the user. returned: success - type: string + type: str sample: developers account_type: description: Type of the account. returned: success - type: string + type: str sample: user timezone: description: Timezone of the user. returned: success - type: string + type: str sample: enabled created: description: Date the user was created. returned: success - type: string + type: str sample: Doe state: description: State of the user. returned: success - type: string + type: str sample: enabled domain: description: Domain the user is related. returned: success - type: string + type: str sample: ROOT ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py b/lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py index 942e5fe09b..a14235eab5 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py @@ -109,57 +109,57 @@ RETURN = ''' id: description: UUID of the snapshot. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: Name of the snapshot. returned: success - type: string + type: str sample: snapshot before update display_name: description: Display name of the snapshot. returned: success - type: string + type: str sample: snapshot before update created: description: date of the snapshot. returned: success - type: string + type: str sample: 2015-03-29T14:57:06+0200 current: description: true if the snapshot is current returned: success - type: boolean + type: bool sample: True state: description: state of the vm snapshot returned: success - type: string + type: str sample: Allocated type: description: type of vm snapshot returned: success - type: string + type: str sample: DiskAndMemory description: description: description of vm snapshot returned: success - type: string + type: str sample: snapshot brought to you by Ansible domain: description: Domain the vm snapshot is related to. returned: success - type: string + type: str sample: example domain account: description: Account the vm snapshot is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the vm snapshot is related to. returned: success - type: string + type: str sample: Production ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_volume.py b/lib/ansible/modules/cloud/cloudstack/cs_volume.py index 1c05e0cbdd..c566a1c8d9 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_volume.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_volume.py @@ -149,72 +149,72 @@ RETURN = ''' id: description: ID of the volume. returned: success - type: string + type: str sample: name: description: Name of the volume. returned: success - type: string + type: str sample: web-volume-01 display_name: description: Display name of the volume. returned: success - type: string + type: str sample: web-volume-01 group: description: Group the volume belongs to returned: success - type: string + type: str sample: web domain: description: Domain the volume belongs to returned: success - type: string + type: str sample: example domain project: description: Project the volume belongs to returned: success - type: string + type: str sample: Production zone: description: Name of zone the volume is in. returned: success - type: string + type: str sample: ch-gva-2 created: description: Date of the volume was created. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 attached: description: Date of the volume was attached. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 type: description: Disk volume type. returned: success - type: string + type: str sample: DATADISK size: description: Size of disk volume. returned: success - type: string + type: str sample: 20 vm: description: Name of the vm the volume is attached to (not returned when detached) returned: success - type: string + type: str sample: web-01 state: description: State of the volume returned: success - type: string + type: str sample: Attached device_id: description: Id of the device on user vm the volume is attached to (not returned when detached) returned: success - type: string + type: str sample: 1 ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vpc.py b/lib/ansible/modules/cloud/cloudstack/cs_vpc.py index b791a14a11..54c06f8d32 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vpc.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vpc.py @@ -121,72 +121,72 @@ RETURN = ''' id: description: "UUID of the VPC." returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: "Name of the VPC." returned: success - type: string + type: str sample: my_vpc display_text: description: "Display text of the VPC." returned: success - type: string + type: str sample: My example VPC cidr: description: "CIDR of the VPC." returned: success - type: string + type: str sample: 10.10.0.0/16 network_domain: description: "Network domain of the VPC." returned: success - type: string + type: str sample: example.com region_level_vpc: description: "Whether the VPC is region level or not." returned: success - type: boolean + type: bool sample: true restart_required: description: "Whether the VPC router needs a restart or not." returned: success - type: boolean + type: bool sample: true distributed_vpc_router: description: "Whether the VPC uses distributed router or not." returned: success - type: boolean + type: bool sample: true redundant_vpc_router: description: "Whether the VPC has redundant routers or not." returned: success - type: boolean + type: bool sample: true domain: description: "Domain the VPC is related to." returned: success - type: string + type: str sample: example domain account: description: "Account the VPC is related to." returned: success - type: string + type: str sample: example account project: description: "Name of project the VPC is related to." returned: success - type: string + type: str sample: Production zone: description: "Name of zone the VPC is in." returned: success - type: string + type: str sample: ch-gva-2 state: description: "State of the VPC." returned: success - type: string + type: str sample: Enabled tags: description: "List of resource tags associated with the VPC." diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py b/lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py index 7085339523..dd83fed3c4 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py @@ -109,27 +109,27 @@ RETURN = ''' id: description: UUID of the vpc offering. returned: success - type: string + type: str sample: a6f7a5fc-43f8-11e5-a151-feff819cdc9f name: description: The name of the vpc offering returned: success - type: string + type: str sample: MyCustomVPCOffering display_text: description: The display text of the vpc offering returned: success - type: string + type: str sample: My vpc offering state: description: The state of the vpc offering returned: success - type: string + type: str sample: Enabled service_offering_id: description: The service offering ID. returned: success - type: string + type: str sample: c5f7a5fc-43f8-11e5-a151-feff819cdc9f is_default: description: Whether VPC offering is the default offering or not. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py b/lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py index 6db5b3bda1..a145749485 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py @@ -90,32 +90,32 @@ RETURN = r''' id: description: UUID of the VPN connection. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 vpn_gateway_id: description: UUID of the VPN gateway. returned: success - type: string + type: str sample: 04589590-ac63-93f5-4ffc-b698b8ac38b6 domain: description: Domain the VPN connection is related to. returned: success - type: string + type: str sample: example domain account: description: Account the VPN connection is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the VPN connection is related to. returned: success - type: string + type: str sample: Production created: description: Date the connection was created. returned: success - type: string + type: str sample: 2014-12-01T14:57:57+0100 dpd: description: Whether dead pear detection is enabled or not. @@ -130,7 +130,7 @@ esp_lifetime: esp_policy: description: IKE policy of the VPN connection. returned: success - type: string + type: str sample: aes256-sha1;modp1536 force_encap: description: Whether encapsulation for NAT traversal is enforced or not. @@ -145,7 +145,7 @@ ike_lifetime: ike_policy: description: ESP policy of the VPN connection. returned: success - type: string + type: str sample: aes256-sha1;modp1536 cidrs: description: List of CIDRs of the customer gateway. @@ -160,17 +160,17 @@ passive: public_ip: description: IP address of the VPN gateway. returned: success - type: string + type: str sample: 10.100.212.10 gateway: description: IP address of the VPN customer gateway. returned: success - type: string + type: str sample: 10.101.214.10 state: description: State of the VPN connection. returned: success - type: string + type: str sample: Connected ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py b/lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py index af230fcf22..871d7a40aa 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py @@ -112,27 +112,27 @@ RETURN = r''' id: description: UUID of the VPN customer gateway. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 gateway: description: IP address of the VPN customer gateway. returned: success - type: string + type: str sample: 10.100.212.10 domain: description: Domain the VPN customer gateway is related to. returned: success - type: string + type: str sample: example domain account: description: Account the VPN customer gateway is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the VPN customer gateway is related to. returned: success - type: string + type: str sample: Production dpd: description: Whether dead pear detection is enabled or not. @@ -147,7 +147,7 @@ esp_lifetime: esp_policy: description: IKE policy of the VPN customer gateway. returned: success - type: string + type: str sample: aes256-sha1;modp1536 force_encap: description: Whether encapsulation for NAT traversal is enforced or not. @@ -162,12 +162,12 @@ ike_lifetime: ike_policy: description: ESP policy of the VPN customer gateway. returned: success - type: string + type: str sample: aes256-sha1;modp1536 name: description: Name of this customer gateway. returned: success - type: string + type: str sample: my vpn customer gateway cidrs: description: List of CIDRs of this customer gateway. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py b/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py index 017c12ea34..97e093b355 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py @@ -80,32 +80,32 @@ RETURN = ''' id: description: UUID of the VPN site-to-site gateway. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 public_ip: description: IP address of the VPN site-to-site gateway. returned: success - type: string + type: str sample: 10.100.212.10 vpc: description: Name of the VPC. returned: success - type: string + type: str sample: My VPC domain: description: Domain the VPN site-to-site gateway is related to. returned: success - type: string + type: str sample: example domain account: description: Account the VPN site-to-site gateway is related to. returned: success - type: string + type: str sample: example account project: description: Name of project the VPN site-to-site gateway is related to. returned: success - type: string + type: str sample: Production ''' diff --git a/lib/ansible/modules/cloud/cloudstack/cs_zone.py b/lib/ansible/modules/cloud/cloudstack/cs_zone.py index caa81b7d7a..969014660c 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_zone.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_zone.py @@ -118,62 +118,62 @@ RETURN = ''' id: description: UUID of the zone. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the zone. returned: success - type: string + type: str sample: zone01 dns1: description: First DNS for the zone. returned: success - type: string + type: str sample: 8.8.8.8 dns2: description: Second DNS for the zone. returned: success - type: string + type: str sample: 8.8.4.4 internal_dns1: description: First internal DNS for the zone. returned: success - type: string + type: str sample: 8.8.8.8 internal_dns2: description: Second internal DNS for the zone. returned: success - type: string + type: str sample: 8.8.4.4 dns1_ipv6: description: First IPv6 DNS for the zone. returned: success - type: string + type: str sample: "2001:4860:4860::8888" dns2_ipv6: description: Second IPv6 DNS for the zone. returned: success - type: string + type: str sample: "2001:4860:4860::8844" allocation_state: description: State of the zone. returned: success - type: string + type: str sample: Enabled domain: description: Domain the zone is related to. returned: success - type: string + type: str sample: ROOT network_domain: description: Network domain for the zone. returned: success - type: string + type: str sample: example.com network_type: description: Network type for the zone. returned: success - type: string + type: str sample: basic local_storage_enabled: description: Local storage offering enabled. @@ -188,17 +188,17 @@ securitygroups_enabled: guest_cidr_address: description: Guest CIDR address for the zone returned: success - type: string + type: str sample: 10.1.1.0/24 dhcp_provider: description: DHCP provider for the zone returned: success - type: string + type: str sample: VirtualRouter zone_token: description: Zone token returned: success - type: string + type: str sample: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7 tags: description: List of resource tags associated with the zone. diff --git a/lib/ansible/modules/cloud/cloudstack/cs_zone_facts.py b/lib/ansible/modules/cloud/cloudstack/cs_zone_facts.py index 6ad5f6cd28..77f13f0ce0 100644 --- a/lib/ansible/modules/cloud/cloudstack/cs_zone_facts.py +++ b/lib/ansible/modules/cloud/cloudstack/cs_zone_facts.py @@ -48,62 +48,62 @@ RETURN = ''' id: description: UUID of the zone. returned: success - type: string + type: str sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 name: description: Name of the zone. returned: success - type: string + type: str sample: zone01 dns1: description: First DNS for the zone. returned: success - type: string + type: str sample: 8.8.8.8 dns2: description: Second DNS for the zone. returned: success - type: string + type: str sample: 8.8.4.4 internal_dns1: description: First internal DNS for the zone. returned: success - type: string + type: str sample: 8.8.8.8 internal_dns2: description: Second internal DNS for the zone. returned: success - type: string + type: str sample: 8.8.4.4 dns1_ipv6: description: First IPv6 DNS for the zone. returned: success - type: string + type: str sample: "2001:4860:4860::8888" dns2_ipv6: description: Second IPv6 DNS for the zone. returned: success - type: string + type: str sample: "2001:4860:4860::8844" allocation_state: description: State of the zone. returned: success - type: string + type: str sample: Enabled domain: description: Domain the zone is related to. returned: success - type: string + type: str sample: ROOT network_domain: description: Network domain for the zone. returned: success - type: string + type: str sample: example.com network_type: description: Network type for the zone. returned: success - type: string + type: str sample: basic local_storage_enabled: description: Local storage offering enabled. @@ -118,17 +118,17 @@ securitygroups_enabled: guest_cidr_address: description: Guest CIDR address for the zone returned: success - type: string + type: str sample: 10.1.1.0/24 dhcp_provider: description: DHCP provider for the zone returned: success - type: string + type: str sample: VirtualRouter zone_token: description: Zone token returned: success - type: string + type: str sample: ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7 tags: description: List of resource tags associated with the zone. diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_account_facts.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_account_facts.py index c40db14f85..84660aeb1c 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_account_facts.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_account_facts.py @@ -42,7 +42,7 @@ RETURN = ''' data: description: DigitalOcean account facts returned: success - type: dictionary + type: dict sample: { "droplet_limit": 10, "email": "testuser1@gmail.com", diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_block_storage.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_block_storage.py index 98cee2cf8d..ea123e72b8 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_block_storage.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_block_storage.py @@ -100,7 +100,7 @@ RETURN = ''' id: description: Unique identifier of a Block Storage volume returned during creation. returned: changed - type: string + type: str sample: "69b25d9a-494c-12e6-a5af-001f53126b44" ''' diff --git a/lib/ansible/modules/cloud/dimensiondata/dimensiondata_network.py b/lib/ansible/modules/cloud/dimensiondata/dimensiondata_network.py index 7805d9a1ef..6b0fe67206 100644 --- a/lib/ansible/modules/cloud/dimensiondata/dimensiondata_network.py +++ b/lib/ansible/modules/cloud/dimensiondata/dimensiondata_network.py @@ -81,31 +81,31 @@ network: contains: id: description: Network ID. - type: string + type: str sample: "8c787000-a000-4050-a215-280893411a7d" name: description: Network name. - type: string + type: str sample: "My network" description: description: Network description. - type: string + type: str sample: "My network description" location: description: Datacenter location. - type: string + type: str sample: NA3 status: description: Network status. (MCP 2.0 only) - type: string + type: str sample: NORMAL private_net: description: Private network subnet. (MCP 1.0 only) - type: string + type: str sample: "10.2.3.0" multicast: description: Multicast enabled? (MCP 1.0 only) - type: boolean + type: bool sample: false ''' import traceback diff --git a/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py b/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py index 9d569ba472..12b6e05706 100644 --- a/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py +++ b/lib/ansible/modules/cloud/dimensiondata/dimensiondata_vlan.py @@ -112,23 +112,23 @@ vlan: contains: id: description: VLAN ID. - type: string + type: str sample: "aaaaa000-a000-4050-a215-2808934ccccc" name: description: VLAN name. - type: string + type: str sample: "My VLAN" description: description: VLAN description. - type: string + type: str sample: "My VLAN description" location: description: Datacenter location. - type: string + type: str sample: NA3 private_ipv4_base_address: description: The base address for the VLAN's private IPV4 network. - type: string + type: str sample: 192.168.23.0 private_ipv4_prefix_size: description: The prefix size for the VLAN's private IPV4 network. @@ -136,11 +136,11 @@ vlan: sample: 24 private_ipv4_gateway_address: description: The gateway address for the VLAN's private IPV4 network. - type: string + type: str sample: 192.168.23.1 private_ipv6_base_address: description: The base address for the VLAN's IPV6 network. - type: string + type: str sample: 2402:9900:111:1195:0:0:0:0 private_ipv6_prefix_size: description: The prefix size for the VLAN's IPV6 network. @@ -148,11 +148,11 @@ vlan: sample: 64 private_ipv6_gateway_address: description: The gateway address for the VLAN's IPV6 network. - type: string + type: str sample: 2402:9900:111:1195:0:0:0:1 status: description: VLAN status. - type: string + type: str sample: NORMAL ''' diff --git a/lib/ansible/modules/cloud/docker/docker_config.py b/lib/ansible/modules/cloud/docker/docker_config.py index f123f253ca..ac0a9fe2c3 100644 --- a/lib/ansible/modules/cloud/docker/docker_config.py +++ b/lib/ansible/modules/cloud/docker/docker_config.py @@ -140,7 +140,7 @@ config_id: description: - The ID assigned by Docker to the config object. returned: success and C(state == "present") - type: string + type: str sample: 'hzehrmyjigmcp2gb6nlhmjqcv' ''' diff --git a/lib/ansible/modules/cloud/docker/docker_secret.py b/lib/ansible/modules/cloud/docker/docker_secret.py index 9a9af055e7..a5aa00e577 100644 --- a/lib/ansible/modules/cloud/docker/docker_secret.py +++ b/lib/ansible/modules/cloud/docker/docker_secret.py @@ -135,7 +135,7 @@ secret_id: description: - The ID assigned by Docker to the secret object. returned: success - type: string + type: str sample: 'hzehrmyjigmcp2gb6nlhmjqcv' ''' diff --git a/lib/ansible/modules/cloud/docker/docker_service.py b/lib/ansible/modules/cloud/docker/docker_service.py index 79f8003558..dbbe9b5aad 100644 --- a/lib/ansible/modules/cloud/docker/docker_service.py +++ b/lib/ansible/modules/cloud/docker/docker_service.py @@ -333,7 +333,7 @@ service: IPAddress: description: The IP address assigned to the container. returned: success - type: string + type: str example: 172.17.0.2 IPPrefixLen: description: Number of bits used by the subnet. @@ -399,11 +399,11 @@ actions: name: description: name of the image returned: always - type: string + type: str id: description: image hash returned: always - type: string + type: str built_image: description: Provides image details when a new image is built for the service. returned: on image build @@ -412,11 +412,11 @@ actions: name: description: name of the image returned: always - type: string + type: str id: description: image hash returned: always - type: string + type: str action: description: A descriptive name of the action to be performed on the service's containers. @@ -426,15 +426,15 @@ actions: id: description: the container's long ID returned: always - type: string + type: str name: description: the container's name returned: always - type: string + type: str short_id: description: the container's short ID returned: always - type: string + type: str ''' import os diff --git a/lib/ansible/modules/cloud/google/gcdns_record.py b/lib/ansible/modules/cloud/google/gcdns_record.py index bd7b4a7e6a..d45700dbb1 100644 --- a/lib/ansible/modules/cloud/google/gcdns_record.py +++ b/lib/ansible/modules/cloud/google/gcdns_record.py @@ -251,17 +251,17 @@ RETURN = ''' overwrite: description: Whether to the module was allowed to overwrite the record returned: success - type: boolean + type: bool sample: True record: description: Fully-qualified domain name of the resource record returned: success - type: string + type: str sample: mail.example.com. state: description: Whether the record is present or absent returned: success - type: string + type: str sample: present ttl: description: The time-to-live of the resource record @@ -271,7 +271,7 @@ ttl: type: description: The type of the resource record returned: success - type: string + type: str sample: A record_data: description: The resource record values @@ -281,12 +281,12 @@ record_data: zone: description: The dns name of the zone returned: success - type: string + type: str sample: example.com. zone_id: description: The Google Cloud DNS ID of the zone returned: success - type: string + type: str sample: example-com ''' diff --git a/lib/ansible/modules/cloud/google/gcdns_zone.py b/lib/ansible/modules/cloud/google/gcdns_zone.py index 5805e5a1ee..5371e964d5 100644 --- a/lib/ansible/modules/cloud/google/gcdns_zone.py +++ b/lib/ansible/modules/cloud/google/gcdns_zone.py @@ -86,17 +86,17 @@ RETURN = ''' description: description: The zone's description returned: success - type: string + type: str sample: This is an awesome zone state: description: Whether the zone is present or absent returned: success - type: string + type: str sample: present zone: description: The zone's DNS name returned: success - type: string + type: str sample: example.com. ''' diff --git a/lib/ansible/modules/cloud/google/gce_eip.py b/lib/ansible/modules/cloud/google/gce_eip.py index a243dd5ef1..40f8822e91 100644 --- a/lib/ansible/modules/cloud/google/gce_eip.py +++ b/lib/ansible/modules/cloud/google/gce_eip.py @@ -64,17 +64,17 @@ RETURN = ''' address: description: IP address being operated on returned: always - type: string + type: str sample: "35.186.222.233" name: description: name of the address being operated on returned: always - type: string + type: str sample: "my-address" region: description: Which region an address belongs. returned: always - type: string + type: str sample: "global" ''' diff --git a/lib/ansible/modules/cloud/google/gce_mig.py b/lib/ansible/modules/cloud/google/gce_mig.py index 662356e78c..0a251517b7 100644 --- a/lib/ansible/modules/cloud/google/gce_mig.py +++ b/lib/ansible/modules/cloud/google/gce_mig.py @@ -159,19 +159,19 @@ RETURN = ''' zone: description: Zone in which to launch MIG. returned: always - type: string + type: str sample: "us-central1-b" template: description: Instance Template to use for VMs. Must exist prior to using with MIG. returned: changed - type: string + type: str sample: "my-instance-template" name: description: Name of the Managed Instance Group. returned: changed - type: string + type: str sample: "my-managed-instance-group" named_ports: diff --git a/lib/ansible/modules/cloud/google/gce_net.py b/lib/ansible/modules/cloud/google/gce_net.py index 27e5df5b09..a1a418eb61 100644 --- a/lib/ansible/modules/cloud/google/gce_net.py +++ b/lib/ansible/modules/cloud/google/gce_net.py @@ -166,25 +166,25 @@ RETURN = ''' allowed: description: Rules (ports and protocols) specified by this firewall rule. returned: When specified - type: string + type: str sample: "tcp:80;icmp" fwname: description: Name of the firewall rule. returned: When specified - type: string + type: str sample: "my-fwname" ipv4_range: description: IPv4 range of the specified network or subnetwork. returned: when specified or when a subnetwork is created - type: string + type: str sample: "10.0.0.0/16" name: description: Name of the network. returned: always - type: string + type: str sample: "my-network" src_range: @@ -202,19 +202,19 @@ src_tags: state: description: State of the item operated on. returned: always - type: string + type: str sample: "present" subnet_name: description: Name of the subnetwork. returned: when specified or when a subnetwork is created - type: string + type: str sample: "my-subnetwork" subnet_region: description: Region of the specified subnet. returned: when specified or when a subnetwork is created - type: string + type: str sample: "us-east1" target_tags: diff --git a/lib/ansible/modules/cloud/google/gcp_backend_service.py b/lib/ansible/modules/cloud/google/gcp_backend_service.py index d65157edf9..d93d16c443 100644 --- a/lib/ansible/modules/cloud/google/gcp_backend_service.py +++ b/lib/ansible/modules/cloud/google/gcp_backend_service.py @@ -115,17 +115,17 @@ RETURN = ''' backend_service_created: description: Indicator Backend Service was created. returned: When a Backend Service is created. - type: boolean + type: bool sample: "True" backend_service_deleted: description: Indicator Backend Service was deleted. returned: When a Backend Service is deleted. - type: boolean + type: bool sample: "True" backend_service_name: description: Name of the Backend Service. returned: Always. - type: string + type: str sample: "my-backend-service" backends: description: List of backends (comprised of instance_group) that @@ -136,7 +136,7 @@ backends: enable_cdn: description: If Cloud CDN is enabled. null if not set. returned: When a backend service exists. - type: boolean + type: bool sample: "True" healthchecks: description: List of healthchecks applied to the Backend Service. @@ -146,12 +146,12 @@ healthchecks: protocol: description: Protocol used to communicate with the Backends. returned: When a Backend Service exists. - type: string + type: str sample: "HTTP" port_name: description: Name of Backend Port. returned: When a Backend Service exists. - type: string + type: str sample: "myhttpport" timeout: description: In seconds, how long before a request sent to a backend is diff --git a/lib/ansible/modules/cloud/lxc/lxc_container.py b/lib/ansible/modules/cloud/lxc/lxc_container.py index e0be3e4145..ffea85c83e 100644 --- a/lib/ansible/modules/cloud/lxc/lxc_container.py +++ b/lib/ansible/modules/cloud/lxc/lxc_container.py @@ -371,7 +371,7 @@ lxc_container: name: description: name of the lxc container returned: success - type: string + type: str sample: test_host init_pid: description: pid of the lxc init process @@ -391,17 +391,17 @@ lxc_container: state: description: resulting state of the container returned: success - type: string + type: str sample: "running" archive: description: resulting state of the container returned: success, when archive is true - type: string + type: str sample: "/tmp/test-container-config.tar" clone: description: if the container was cloned returned: success, when clone_name is specified - type: boolean + type: bool sample: True """ diff --git a/lib/ansible/modules/cloud/lxd/lxd_container.py b/lib/ansible/modules/cloud/lxd/lxd_container.py index 31ecdbf708..29af63f10a 100644 --- a/lib/ansible/modules/cloud/lxd/lxd_container.py +++ b/lib/ansible/modules/cloud/lxd/lxd_container.py @@ -229,7 +229,7 @@ addresses: old_state: description: The old state of the container returned: when state is started or restarted - type: string + type: str sample: "stopped" logs: description: The logs of requests and responses. diff --git a/lib/ansible/modules/cloud/lxd/lxd_profile.py b/lib/ansible/modules/cloud/lxd/lxd_profile.py index c90b057fe3..524fa4a87d 100644 --- a/lib/ansible/modules/cloud/lxd/lxd_profile.py +++ b/lib/ansible/modules/cloud/lxd/lxd_profile.py @@ -155,7 +155,7 @@ RETURN = ''' old_state: description: The old state of the profile returned: success - type: string + type: str sample: "absent" logs: description: The logs of requests and responses. diff --git a/lib/ansible/modules/cloud/memset/memset_dns_reload.py b/lib/ansible/modules/cloud/memset/memset_dns_reload.py index 0705a09053..135e70f1cd 100644 --- a/lib/ansible/modules/cloud/memset/memset_dns_reload.py +++ b/lib/ansible/modules/cloud/memset/memset_dns_reload.py @@ -71,17 +71,17 @@ memset_api: id: description: Job ID. returned: always - type: string + type: str sample: "c9cc8ad2a3e3fb8c63ed83c424928ef8" status: description: Job status. returned: always - type: string + type: str sample: "DONE" type: description: Job type. returned: always - type: string + type: str sample: "dns" ''' diff --git a/lib/ansible/modules/cloud/memset/memset_memstore_facts.py b/lib/ansible/modules/cloud/memset/memset_memstore_facts.py index d3f97b38be..45b9141311 100644 --- a/lib/ansible/modules/cloud/memset/memset_memstore_facts.py +++ b/lib/ansible/modules/cloud/memset/memset_memstore_facts.py @@ -58,32 +58,32 @@ memset_api: bytes_out: description: Outbound CDN bandwidth for the last 24 hours in bytes returned: always - type: integer + type: int sample: 1000 requests: description: Number of requests in the last 24 hours returned: always - type: integer + type: int sample: 10 bytes_in: description: Inbound CDN bandwidth for the last 24 hours in bytes returned: always - type: integer + type: int sample: 1000 containers: description: Number of containers returned: always - type: integer + type: int sample: 10 bytes: description: Space used in bytes returned: always - type: integer + type: int sample: 3860997965 objs: description: Number of objects returned: always - type: integer + type: int sample: 1000 bandwidth: description: Dictionary of CDN bandwidth facts @@ -93,17 +93,17 @@ memset_api: bytes_out: description: Outbound bandwidth for the last 24 hours in bytes returned: always - type: integer + type: int sample: 1000 requests: description: Number of requests in the last 24 hours returned: always - type: integer + type: int sample: 10 bytes_in: description: Inbound bandwidth for the last 24 hours in bytes returned: always - type: integer + type: int sample: 1000 ''' diff --git a/lib/ansible/modules/cloud/memset/memset_server_facts.py b/lib/ansible/modules/cloud/memset/memset_server_facts.py index eb34646b74..fb6ed127a3 100644 --- a/lib/ansible/modules/cloud/memset/memset_server_facts.py +++ b/lib/ansible/modules/cloud/memset/memset_server_facts.py @@ -53,22 +53,22 @@ memset_api: backups: description: Whether this server has a backup service. returned: always - type: boolean + type: bool sample: true control_panel: description: Whether the server has a control panel (i.e. cPanel). returned: always - type: string + type: str sample: 'cpanel' data_zone: description: The data zone the server is in. returned: always - type: string + type: str sample: 'Memset Public Cloud' expiry_date: description: Current expiry date of the server. returned: always - type: string + type: str sample: '2018-08-10' firewall_rule_group: description: Details about the firewall group this server is in. @@ -102,17 +102,17 @@ memset_api: firewall_type: description: The type of firewall the server has (i.e. self-managed, managed). returned: always - type: string + type: str sample: 'managed' host_name: description: The server's hostname. returned: always - type: string + type: str sample: 'testyaa1.miniserver.com' ignore_monitoring_off: description: When true, Memset won't remind the customer that monitoring is disabled. returned: always - type: boolean + type: bool sample: true ips: description: List of dictionaries of all IP addresses assigned to the server. @@ -130,17 +130,17 @@ memset_api: monitor: description: Whether the server has monitoring enabled. returned: always - type: boolean + type: bool sample: true monitoring_level: description: The server's monitoring level (i.e. basic). returned: always - type: string + type: str sample: 'basic' name: description: Server name (same as the service name). returned: always - type: string + type: str sample: 'testyaa1' network_zones: description: The network zone(s) the server is in. @@ -150,72 +150,72 @@ memset_api: nickname: description: Customer-set nickname for the server. returned: always - type: string + type: str sample: 'database server' no_auto_reboot: description: Whether or not to reboot the server if monitoring detects it down. returned: always - type: boolean + type: bool sample: true no_nrpe: description: Whether Memset should use NRPE to monitor this server. returned: always - type: boolean + type: bool sample: true os: description: The server's Operating System. returned: always - type: string + type: str sample: 'debian_stretch_64' penetration_patrol: description: Intrusion detection support level for this server. returned: always - type: string + type: str sample: 'managed' penetration_patrol_alert_level: description: The alert level at which notifications are sent. returned: always - type: integer + type: int sample: 10 primary_ip: description: Server's primary IP. returned: always - type: string + type: str sample: '1.2.3.4' renewal_price_amount: description: Renewal cost for the server. returned: always - type: string + type: str sample: '30.00' renewal_price_currency: description: Currency for renewal payments. returned: always - type: string + type: str sample: 'GBP' renewal_price_vat: description: VAT rate for renewal payments returned: always - type: string + type: str sample: '20' start_date: description: Server's start date. returned: always - type: string + type: str sample: '2013-04-10' status: description: Current status of the server (i.e. live, onhold). returned: always - type: string + type: str sample: 'LIVE' support_level: description: Support level included with the server. returned: always - type: string + type: str sample: 'managed' type: description: What this server is (i.e. dedicated) returned: always - type: string + type: str sample: 'miniserver' vlans: description: Dictionary of tagged and untagged VLANs this server is in. @@ -228,7 +228,7 @@ memset_api: vulnscan: description: Vulnerability scanning level. returned: always - type: string + type: str sample: 'basic' ''' diff --git a/lib/ansible/modules/cloud/memset/memset_zone.py b/lib/ansible/modules/cloud/memset/memset_zone.py index 222f2775b1..4ace728b9d 100644 --- a/lib/ansible/modules/cloud/memset/memset_zone.py +++ b/lib/ansible/modules/cloud/memset/memset_zone.py @@ -89,12 +89,12 @@ memset_api: id: description: Zone id returned: always - type: string + type: str sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c" nickname: description: Zone name returned: always - type: string + type: str sample: "example.com" records: description: List of DNS records for domains in this zone diff --git a/lib/ansible/modules/cloud/memset/memset_zone_domain.py b/lib/ansible/modules/cloud/memset/memset_zone_domain.py index 507d975a43..b7618d2992 100644 --- a/lib/ansible/modules/cloud/memset/memset_zone_domain.py +++ b/lib/ansible/modules/cloud/memset/memset_zone_domain.py @@ -69,12 +69,12 @@ memset_api: domain: description: Domain name returned: always - type: string + type: str sample: "example.com" id: description: Domain ID returned: always - type: string + type: str sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c" ''' diff --git a/lib/ansible/modules/cloud/memset/memset_zone_record.py b/lib/ansible/modules/cloud/memset/memset_zone_record.py index a7b8caa7cb..8d646cbd35 100644 --- a/lib/ansible/modules/cloud/memset/memset_zone_record.py +++ b/lib/ansible/modules/cloud/memset/memset_zone_record.py @@ -118,42 +118,42 @@ memset_api: address: description: Record content (may be an IP, string or blank depending on record type). returned: always - type: string + type: str sample: 1.1.1.1 id: description: Record ID. returned: always - type: string + type: str sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c" priority: description: Priority for C(MX) and C(SRV) records. returned: always - type: integer + type: int sample: 10 record: description: Name of record. returned: always - type: string + type: str sample: "www" relative: description: Adds the current domain onto the address field for C(CNAME), C(MX), C(NS) and C(SRV) types. returned: always - type: boolean + type: bool sample: False ttl: description: Record TTL. returned: always - type: integer + type: int sample: 10 type: description: Record type. returned: always - type: string + type: str sample: AAAA zone_id: description: Zone ID. returned: always - type: string + type: str sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c" ''' diff --git a/lib/ansible/modules/cloud/misc/serverless.py b/lib/ansible/modules/cloud/misc/serverless.py index 89f1ad16e5..49f43224d5 100644 --- a/lib/ansible/modules/cloud/misc/serverless.py +++ b/lib/ansible/modules/cloud/misc/serverless.py @@ -112,16 +112,16 @@ EXAMPLES = """ RETURN = """ service_name: - type: string + type: str description: The service name specified in the serverless.yml that was just deployed. returned: always sample: my-fancy-service-dev state: - type: string + type: str description: Whether the stack for the serverless project is present/absent. returned: always command: - type: string + type: str description: Full `serverless` command run by this module, in case you want to re-run the command outside the module. returned: always sample: serverless deploy --stage production diff --git a/lib/ansible/modules/cloud/misc/terraform.py b/lib/ansible/modules/cloud/misc/terraform.py index ae07b6005e..19e42bdabc 100644 --- a/lib/ansible/modules/cloud/misc/terraform.py +++ b/lib/ansible/modules/cloud/misc/terraform.py @@ -139,19 +139,19 @@ outputs: returned: always description: Whether Terraform has marked this value as sensitive type: - type: string + type: str returned: always description: The type of the value (string, int, etc) value: returned: always description: The value of the output as interpolated by Terraform stdout: - type: string + type: str description: Full `terraform` command stdout, in case you want to display it or examine the event log returned: always sample: '' command: - type: string + type: str description: Full `terraform` command built by this module, in case you want to re-run the command outside the module or debug a problem. returned: always sample: terraform apply ... diff --git a/lib/ansible/modules/cloud/misc/virt.py b/lib/ansible/modules/cloud/misc/virt.py index 8848ae1338..ad3850a060 100644 --- a/lib/ansible/modules/cloud/misc/virt.py +++ b/lib/ansible/modules/cloud/misc/virt.py @@ -122,7 +122,7 @@ list_vms: # for status command status: description: The status of the VM, among running, crashed, paused and shutdown - type: string + type: str sample: "success" returned: success ''' diff --git a/lib/ansible/modules/cloud/opennebula/one_image.py b/lib/ansible/modules/cloud/opennebula/one_image.py index 825d8ea43c..a810cd7db3 100644 --- a/lib/ansible/modules/cloud/opennebula/one_image.py +++ b/lib/ansible/modules/cloud/opennebula/one_image.py @@ -125,7 +125,7 @@ id: sample: 153 name: description: image name - type: string + type: str returned: success sample: app1 group_id: @@ -135,7 +135,7 @@ group_id: sample: 1 group_name: description: image's group name - type: string + type: str returned: success sample: one-users owner_id: @@ -145,12 +145,12 @@ owner_id: sample: 143 owner_name: description: image's owner name - type: string + type: str returned: success sample: ansible-test state: description: state of image instance - type: string + type: str returned: success sample: READY used: diff --git a/lib/ansible/modules/cloud/opennebula/one_image_facts.py b/lib/ansible/modules/cloud/opennebula/one_image_facts.py index d850a0be9b..f0c2d4908e 100644 --- a/lib/ansible/modules/cloud/opennebula/one_image_facts.py +++ b/lib/ansible/modules/cloud/opennebula/one_image_facts.py @@ -109,7 +109,7 @@ images: sample: 153 name: description: image name - type: string + type: str sample: app1 group_id: description: image's group id @@ -117,7 +117,7 @@ images: sample: 1 group_name: description: image's group name - type: string + type: str sample: one-users owner_id: description: image's owner id @@ -125,11 +125,11 @@ images: sample: 143 owner_name: description: image's owner name - type: string + type: str sample: ansible-test state: description: state of image instance - type: string + type: str sample: READY used: description: is image in use diff --git a/lib/ansible/modules/cloud/opennebula/one_service.py b/lib/ansible/modules/cloud/opennebula/one_service.py index 2e4dc0a766..6c32068e96 100644 --- a/lib/ansible/modules/cloud/opennebula/one_service.py +++ b/lib/ansible/modules/cloud/opennebula/one_service.py @@ -187,7 +187,7 @@ service_id: sample: 153 service_name: description: service name - type: string + type: str returned: success sample: app1 group_id: @@ -197,7 +197,7 @@ group_id: sample: 1 group_name: description: service's group name - type: string + type: str returned: success sample: one-users owner_id: @@ -207,12 +207,12 @@ owner_id: sample: 143 owner_name: description: service's owner name - type: string + type: str returned: success sample: ansible-test state: description: state of service instance - type: string + type: str returned: success sample: RUNNING mode: diff --git a/lib/ansible/modules/cloud/opennebula/one_vm.py b/lib/ansible/modules/cloud/opennebula/one_vm.py index 98794772f4..80cc6d730d 100644 --- a/lib/ansible/modules/cloud/opennebula/one_vm.py +++ b/lib/ansible/modules/cloud/opennebula/one_vm.py @@ -362,44 +362,44 @@ instances: contains: vm_id: description: vm id - type: integer + type: int sample: 153 vm_name: description: vm name - type: string + type: str sample: foo template_id: description: vm's template id - type: integer + type: int sample: 153 group_id: description: vm's group id - type: integer + type: int sample: 1 group_name: description: vm's group name - type: string + type: str sample: one-users owner_id: description: vm's owner id - type: integer + type: int sample: 143 owner_name: description: vm's owner name - type: string + type: str sample: app-user mode: description: vm's mode - type: string + type: str returned: success sample: 660 state: description: state of an instance - type: string + type: str sample: ACTIVE lcm_state: description: lcm state of an instance that is only relevant when the state is ACTIVE - type: string + type: str sample: RUNNING cpu: description: Percentage of CPU divided by 100 @@ -411,11 +411,11 @@ instances: sample: 2 memory: description: The size of the memory in MB - type: string + type: str sample: 4096 MB disk_size: description: The size of the disk in MB - type: string + type: str sample: 20480 MB networks: description: a list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC @@ -436,7 +436,7 @@ instances: ] uptime_h: description: Uptime of the instance in hours - type: integer + type: int sample: 35 labels: description: A list of string labels that are associated with the instance @@ -464,44 +464,44 @@ tagged_instances: contains: vm_id: description: vm id - type: integer + type: int sample: 153 vm_name: description: vm name - type: string + type: str sample: foo template_id: description: vm's template id - type: integer + type: int sample: 153 group_id: description: vm's group id - type: integer + type: int sample: 1 group_name: description: vm's group name - type: string + type: str sample: one-users owner_id: description: vm's user id - type: integer + type: int sample: 143 owner_name: description: vm's user name - type: string + type: str sample: app-user mode: description: vm's mode - type: string + type: str returned: success sample: 660 state: description: state of an instance - type: string + type: str sample: ACTIVE lcm_state: description: lcm state of an instance that is only relevant when the state is ACTIVE - type: string + type: str sample: RUNNING cpu: description: Percentage of CPU divided by 100 @@ -513,11 +513,11 @@ tagged_instances: sample: 2 memory: description: The size of the memory in MB - type: string + type: str sample: 4096 MB disk_size: description: The size of the disk in MB - type: string + type: str sample: 20480 MB networks: description: a list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC @@ -538,7 +538,7 @@ tagged_instances: ] uptime_h: description: Uptime of the instance in hours - type: integer + type: int sample: 35 labels: description: A list of string labels that are associated with the instance diff --git a/lib/ansible/modules/cloud/openstack/os_coe_cluster_template.py b/lib/ansible/modules/cloud/openstack/os_coe_cluster_template.py index 0df9421c80..755b25162c 100644 --- a/lib/ansible/modules/cloud/openstack/os_coe_cluster_template.py +++ b/lib/ansible/modules/cloud/openstack/os_coe_cluster_template.py @@ -132,7 +132,7 @@ RETURN = ''' id: description: The cluster UUID. returned: On success when I(state) is 'present' - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" cluster_template: description: Dictionary describing the template. @@ -141,15 +141,15 @@ cluster_template: contains: coe: description: The Container Orchestration Engine for this clustertemplate - type: string + type: str sample: kubernetes dns_nameserver: description: The DNS nameserver address - type: string + type: str sample: '8.8.8.8' docker_storage_driver: description: Docker storage driver - type: string + type: str sample: devicemapper docker_volume_size: description: The size in GB of the docker volume @@ -157,21 +157,21 @@ cluster_template: sample: 5 external_network_id: description: The external network to attach to the Cluster - type: string + type: str sample: public fixed_network: description: The fixed network name to attach to the Cluster - type: string + type: str sample: 07767ec6-85f5-44cb-bd63-242a8e7f0d9d fixed_subnet: description: - The fixed subnet name to attach to the Cluster - type: string + type: str sample: 05567ec6-85f5-44cb-bd63-242a8e7f0d9d flavor_id: description: - The flavor of the minion node for this ClusterTemplate - type: string + type: str sample: c1.c1r1 floating_ip_enabled: description: @@ -181,12 +181,12 @@ cluster_template: keypair_id: description: - Name or ID of the keypair to use. - type: string + type: str sample: mykey image_id: description: - Image id the cluster will be based on - type: string + type: str sample: 05567ec6-85f5-44cb-bd63-242a8e7f0e9d labels: description: One or more key/value pairs @@ -196,18 +196,18 @@ cluster_template: description: - Address of a proxy that will receive all HTTP requests and relay them The format is a URL including a port number - type: string + type: str sample: http://10.0.0.11:9090 https_proxy: description: - Address of a proxy that will receive all HTTPS requests and relay them. The format is a URL including a port number - type: string + type: str sample: https://10.0.0.10:8443 master_flavor_id: description: - The flavor of the master node for this ClusterTemplate - type: string + type: str sample: c1.c1r1 master_lb_enabled: description: @@ -218,18 +218,18 @@ cluster_template: name: description: - Name that has to be given to the cluster template - type: string + type: str sample: k8scluster network_driver: description: - The name of the driver used for instantiating container networks - type: string + type: str sample: calico no_proxy: description: - A comma separated list of IPs for which proxies should not be used in the cluster - type: string + type: str sample: 10.0.0.4,10.0.0.5 public: description: @@ -244,7 +244,7 @@ cluster_template: server_type: description: - Server type for this ClusterTemplate - type: string + type: str sample: vm tls_disabled: description: @@ -254,7 +254,7 @@ cluster_template: volume_driver: description: - The name of the driver used for instantiating container volumes - type: string + type: str sample: cinder ''' diff --git a/lib/ansible/modules/cloud/openstack/os_flavor_facts.py b/lib/ansible/modules/cloud/openstack/os_flavor_facts.py index 826e3af919..5f67b351ae 100644 --- a/lib/ansible/modules/cloud/openstack/os_flavor_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_flavor_facts.py @@ -126,12 +126,12 @@ openstack_flavors: id: description: Flavor ID. returned: success - type: string + type: str sample: "515256b8-7027-4d73-aa54-4e30a4a4a339" name: description: Flavor name. returned: success - type: string + type: str sample: "tiny" disk: description: Size of local disk, in GB. diff --git a/lib/ansible/modules/cloud/openstack/os_group.py b/lib/ansible/modules/cloud/openstack/os_group.py index a7c42cb286..3f7e291c1c 100644 --- a/lib/ansible/modules/cloud/openstack/os_group.py +++ b/lib/ansible/modules/cloud/openstack/os_group.py @@ -78,19 +78,19 @@ group: contains: id: description: Unique group ID - type: string + type: str sample: "ee6156ff04c645f481a6738311aea0b0" name: description: Group name - type: string + type: str sample: "demo" description: description: Group description - type: string + type: str sample: "Demo Group" domain_id: description: Domain for the group - type: string + type: str sample: "default" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_image_facts.py b/lib/ansible/modules/cloud/openstack/os_image_facts.py index 4e7d002c26..265cd896d7 100644 --- a/lib/ansible/modules/cloud/openstack/os_image_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_image_facts.py @@ -68,27 +68,27 @@ openstack_image: id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the image. returned: success - type: string + type: str status: description: Image status. returned: success - type: string + type: str created_at: description: Image created at timestamp. returned: success - type: string + type: str deleted: description: Image deleted flag. returned: success - type: boolean + type: bool container_format: description: Container format of the image. returned: success - type: string + type: str min_ram: description: Min amount of RAM required for this image. returned: success @@ -96,11 +96,11 @@ openstack_image: disk_format: description: Disk format of the image. returned: success - type: string + type: str updated_at: description: Image updated at timestamp. returned: success - type: string + type: str properties: description: Additional properties associated with the image. returned: success @@ -112,23 +112,23 @@ openstack_image: protected: description: Image protected flag. returned: success - type: boolean + type: bool checksum: description: Checksum for the image. returned: success - type: string + type: str owner: description: Owner for the image. returned: success - type: string + type: str is_public: description: Is public flag of the image. returned: success - type: boolean + type: bool deleted_at: description: Image deleted at timestamp. returned: success - type: string + type: str size: description: Size of the image. returned: success diff --git a/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py b/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py index 6ad2964b9f..f115f9732b 100644 --- a/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py +++ b/lib/ansible/modules/cloud/openstack/os_ironic_inspect.py @@ -57,19 +57,19 @@ ansible_facts: contains: memory_mb: description: Amount of node memory as updated in the node properties - type: string + type: str sample: "1024" cpu_arch: description: Detected CPU architecture type - type: string + type: str sample: "x86_64" local_gb: description: Total size of local disk storage as updaed in node properties. - type: string + type: str sample: "10" cpus: description: Count of cpu cores defined in the updated node properties. - type: string + type: str sample: "1" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keypair.py b/lib/ansible/modules/cloud/openstack/os_keypair.py index eebb72182d..ac3e566a51 100644 --- a/lib/ansible/modules/cloud/openstack/os_keypair.py +++ b/lib/ansible/modules/cloud/openstack/os_keypair.py @@ -65,20 +65,20 @@ RETURN = ''' id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the keypair. returned: success - type: string + type: str public_key: description: The public key value for the keypair. returned: success - type: string + type: str private_key: description: The private key value for the keypair. returned: Only when a keypair is generated for the user (e.g., when creating one and a public key is not specified). - type: string + type: str ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_domain.py b/lib/ansible/modules/cloud/openstack/os_keystone_domain.py index 29f931ac41..2cf4920100 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_domain.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_domain.py @@ -73,25 +73,25 @@ domain: contains: id: description: Domain ID. - type: string + type: str sample: "474acfe5-be34-494c-b339-50f06aa143e4" name: description: Domain name. - type: string + type: str sample: "demo" description: description: Domain description. - type: string + type: str sample: "Demo Domain" enabled: description: Domain description. - type: boolean + type: bool sample: True id: description: The domain ID. returned: On success when I(state) is 'present' - type: string + type: str sample: "474acfe5-be34-494c-b339-50f06aa143e4" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py b/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py index 2c3a464436..edc0b5f4c3 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py @@ -70,15 +70,15 @@ openstack_domains: id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the domain. returned: success - type: string + type: str description: description: Description of the domain. returned: success - type: string + type: str enabled: description: Flag to indicate if the domain is enabled. returned: success diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py b/lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py index dd80b8009a..3138320d7e 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_endpoint.py @@ -82,27 +82,27 @@ endpoint: contains: id: description: Endpoint ID. - type: string + type: str sample: 3292f020780b4d5baf27ff7e1d224c44 region: description: Region Name. - type: string + type: str sample: RegionOne service_id: description: Service ID. - type: string + type: str sample: b91f1318f735494a825a55388ee118f3 interface: description: Endpoint Interface. - type: string + type: str sample: public url: description: Service URL. - type: string + type: str sample: http://controller:9292 enabled: description: Service status. - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_role.py b/lib/ansible/modules/cloud/openstack/os_keystone_role.py index eb4f23aa0a..e3a752706e 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_role.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_role.py @@ -63,11 +63,11 @@ role: contains: id: description: Unique role ID. - type: string + type: str sample: "677bfab34c844a01b88a217aa12ec4c2" name: description: Role name. - type: string + type: str sample: "demo" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_keystone_service.py b/lib/ansible/modules/cloud/openstack/os_keystone_service.py index 5f9e869705..cd11e4ceca 100644 --- a/lib/ansible/modules/cloud/openstack/os_keystone_service.py +++ b/lib/ansible/modules/cloud/openstack/os_keystone_service.py @@ -76,28 +76,28 @@ service: contains: id: description: Service ID. - type: string + type: str sample: "3292f020780b4d5baf27ff7e1d224c44" name: description: Service name. - type: string + type: str sample: "glance" service_type: description: Service type. - type: string + type: str sample: "image" description: description: Service description. - type: string + type: str sample: "OpenStack Image Service" enabled: description: Service status. - type: boolean + type: bool sample: True id: description: The service ID. returned: On success when I(state) is 'present' - type: string + type: str sample: "3292f020780b4d5baf27ff7e1d224c44" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_listener.py b/lib/ansible/modules/cloud/openstack/os_listener.py index f0534ff0dd..6d29f55e9f 100644 --- a/lib/ansible/modules/cloud/openstack/os_listener.py +++ b/lib/ansible/modules/cloud/openstack/os_listener.py @@ -63,7 +63,7 @@ RETURN = ''' id: description: The listener UUID. returned: On success when I(state) is 'present' - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" listener: description: Dictionary describing the listener. @@ -72,19 +72,19 @@ listener: contains: id: description: Unique UUID. - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" name: description: Name given to the listener. - type: string + type: str sample: "test" description: description: The listener description. - type: string + type: str sample: "description" load_balancer_id: description: The load balancer UUID this listener belongs to. - type: string + type: str sample: "b32eef7e-d2a6-4ea4-a301-60a873f89b3b" loadbalancers: description: A list of load balancer IDs.. @@ -92,11 +92,11 @@ listener: sample: [{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}] provisioning_status: description: The provisioning status of the listener. - type: string + type: str sample: "ACTIVE" operating_status: description: The operating status of the listener. - type: string + type: str sample: "ONLINE" is_admin_state_up: description: The administrative state of the listener. @@ -104,7 +104,7 @@ listener: sample: true protocol: description: The protocol for the listener. - type: string + type: str sample: "HTTP" protocol_port: description: The protocol port number for the listener. diff --git a/lib/ansible/modules/cloud/openstack/os_loadbalancer.py b/lib/ansible/modules/cloud/openstack/os_loadbalancer.py index 09bfc12cb0..adbe90661a 100644 --- a/lib/ansible/modules/cloud/openstack/os_loadbalancer.py +++ b/lib/ansible/modules/cloud/openstack/os_loadbalancer.py @@ -134,7 +134,7 @@ RETURN = ''' id: description: The load balancer UUID. returned: On success when C(state=present) - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" loadbalancer: description: Dictionary describing the load balancer. @@ -143,39 +143,39 @@ loadbalancer: contains: id: description: Unique UUID. - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" name: description: Name given to the load balancer. - type: string + type: str sample: "lingxian_test" vip_network_id: description: Network ID the load balancer virutal IP port belongs in. - type: string + type: str sample: "f171db43-56fd-41cf-82d7-4e91d741762e" vip_subnet_id: description: Subnet ID the load balancer virutal IP port belongs in. - type: string + type: str sample: "c53e3c70-9d62-409a-9f71-db148e7aa853" vip_port_id: description: The load balancer virutal IP port ID. - type: string + type: str sample: "2061395c-1c01-47ab-b925-c91b93df9c1d" vip_address: description: The load balancer virutal IP address. - type: string + type: str sample: "192.168.2.88" public_vip_address: description: The load balancer public VIP address. - type: string + type: str sample: "10.17.8.254" provisioning_status: description: The provisioning status of the load balancer. - type: string + type: str sample: "ACTIVE" operating_status: description: The operating status of the load balancer. - type: string + type: str sample: "ONLINE" is_admin_state_up: description: The administrative state of the load balancer. diff --git a/lib/ansible/modules/cloud/openstack/os_member.py b/lib/ansible/modules/cloud/openstack/os_member.py index ace6db595c..7b5632ec6d 100644 --- a/lib/ansible/modules/cloud/openstack/os_member.py +++ b/lib/ansible/modules/cloud/openstack/os_member.py @@ -64,7 +64,7 @@ RETURN = ''' id: description: The member UUID. returned: On success when I(state) is 'present' - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" member: description: Dictionary describing the member. @@ -73,23 +73,23 @@ member: contains: id: description: Unique UUID. - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" name: description: Name given to the member. - type: string + type: str sample: "test" description: description: The member description. - type: string + type: str sample: "description" provisioning_status: description: The provisioning status of the member. - type: string + type: str sample: "ACTIVE" operating_status: description: The operating status of the member. - type: string + type: str sample: "ONLINE" is_admin_state_up: description: The administrative state of the member. @@ -101,11 +101,11 @@ member: sample: 80 subnet_id: description: The subnet ID the member service is accessible from. - type: string + type: str sample: "489247fa-9c25-11e8-9679-00224d6b7bc1" address: description: The IP address of the backend member server. - type: string + type: str sample: "192.168.2.10" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_network.py b/lib/ansible/modules/cloud/openstack/os_network.py index 4196dabfd7..9515479c83 100644 --- a/lib/ansible/modules/cloud/openstack/os_network.py +++ b/lib/ansible/modules/cloud/openstack/os_network.py @@ -89,11 +89,11 @@ network: contains: id: description: Network ID. - type: string + type: str sample: "4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56" name: description: Network name. - type: string + type: str sample: "ext_network" shared: description: Indicates whether this network is shared across all tenants. @@ -101,11 +101,11 @@ network: sample: false status: description: Network status. - type: string + type: str sample: "ACTIVE" mtu: description: The MTU of a network resource. - type: integer + type: int sample: 0 admin_state_up: description: The administrative state of the network. @@ -121,7 +121,7 @@ network: sample: true tenant_id: description: The tenant ID. - type: string + type: str sample: "06820f94b9f54b119636be2728d216fc" subnets: description: The associated subnets. @@ -129,15 +129,15 @@ network: sample: [] "provider:physical_network": description: The physical network where this network object is implemented. - type: string + type: str sample: my_vlan_net "provider:network_type": description: The type of physical network that maps to this network resource. - type: string + type: str sample: vlan "provider:segmentation_id": description: An isolated segment on the physical network. - type: string + type: str sample: 101 ''' diff --git a/lib/ansible/modules/cloud/openstack/os_networks_facts.py b/lib/ansible/modules/cloud/openstack/os_networks_facts.py index e16cfe3706..705cddc0ea 100644 --- a/lib/ansible/modules/cloud/openstack/os_networks_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_networks_facts.py @@ -94,15 +94,15 @@ openstack_networks: id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the network. returned: success - type: string + type: str status: description: Network status. returned: success - type: string + type: str subnets: description: Subnet(s) included in this network. returned: success @@ -110,11 +110,11 @@ openstack_networks: tenant_id: description: Tenant id associated with this network. returned: success - type: string + type: str shared: description: Network shared flag. returned: success - type: boolean + type: bool ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/cloud/openstack/os_nova_flavor.py b/lib/ansible/modules/cloud/openstack/os_nova_flavor.py index 8dcf334d6f..db7fe09e49 100644 --- a/lib/ansible/modules/cloud/openstack/os_nova_flavor.py +++ b/lib/ansible/modules/cloud/openstack/os_nova_flavor.py @@ -113,12 +113,12 @@ flavor: id: description: Flavor ID. returned: success - type: string + type: str sample: "515256b8-7027-4d73-aa54-4e30a4a4a339" name: description: Flavor name. returned: success - type: string + type: str sample: "tiny" disk: description: Size of local disk, in GB. diff --git a/lib/ansible/modules/cloud/openstack/os_pool.py b/lib/ansible/modules/cloud/openstack/os_pool.py index a258213b76..694305094e 100644 --- a/lib/ansible/modules/cloud/openstack/os_pool.py +++ b/lib/ansible/modules/cloud/openstack/os_pool.py @@ -68,7 +68,7 @@ RETURN = ''' id: description: The pool UUID. returned: On success when I(state) is 'present' - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" listener: description: Dictionary describing the pool. @@ -77,15 +77,15 @@ listener: contains: id: description: Unique UUID. - type: string + type: str sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69" name: description: Name given to the pool. - type: string + type: str sample: "test" description: description: The pool description. - type: string + type: str sample: "description" loadbalancers: description: A list of load balancer IDs. @@ -101,19 +101,19 @@ listener: sample: [{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}] loadbalancer_id: description: The load balancer ID the pool belongs to. This field is set when the pool doesn't belong to any listener in the load balancer. - type: string + type: str sample: "7c4be3f8-9c2f-11e8-83b3-44a8422643a4" listener_id: description: The listener ID the pool belongs to. - type: string + type: str sample: "956aa716-9c2f-11e8-83b3-44a8422643a4" provisioning_status: description: The provisioning status of the pool. - type: string + type: str sample: "ACTIVE" operating_status: description: The operating status of the pool. - type: string + type: str sample: "ONLINE" is_admin_state_up: description: The administrative state of the pool. @@ -121,11 +121,11 @@ listener: sample: true protocol: description: The protocol for the pool. - type: string + type: str sample: "HTTP" lb_algorithm: description: The load balancing algorithm for the pool. - type: string + type: str sample: "ROUND_ROBIN" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_port.py b/lib/ansible/modules/cloud/openstack/os_port.py index 5946b9992c..fd00357ddd 100644 --- a/lib/ansible/modules/cloud/openstack/os_port.py +++ b/lib/ansible/modules/cloud/openstack/os_port.py @@ -148,15 +148,15 @@ RETURN = ''' id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the port. returned: success - type: string + type: str network_id: description: Network ID this port belongs in. returned: success - type: string + type: str security_groups: description: Security group(s) associated with this port. returned: success @@ -164,7 +164,7 @@ security_groups: status: description: Port's status. returned: success - type: string + type: str fixed_ips: description: Fixed ip(s) associated with this port. returned: success @@ -172,7 +172,7 @@ fixed_ips: tenant_id: description: Tenant id associated with this port. returned: success - type: string + type: str allowed_address_pairs: description: Allowed address pairs with this port. returned: success diff --git a/lib/ansible/modules/cloud/openstack/os_port_facts.py b/lib/ansible/modules/cloud/openstack/os_port_facts.py index 4d56cc4d32..e252181b3b 100644 --- a/lib/ansible/modules/cloud/openstack/os_port_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_port_facts.py @@ -70,7 +70,7 @@ openstack_ports: description: The administrative state of the router, which is up (true) or down (false). returned: success - type: boolean + type: bool sample: true allowed_address_pairs: description: A set of zero or more allowed address pairs. An @@ -81,7 +81,7 @@ openstack_ports: "binding:host_id": description: The UUID of the host where the port is allocated. returned: success - type: string + type: str sample: "b4bd682d-234a-4091-aa5b-4b025a6a7759" "binding:profile": description: A dictionary the enables the application running on @@ -106,17 +106,17 @@ openstack_ports: description: The virtual network interface card (vNIC) type that is bound to the neutron port. returned: success - type: string + type: str sample: "normal" device_id: description: The UUID of the device that uses this port. returned: success - type: string + type: str sample: "b4bd682d-234a-4091-aa5b-4b025a6a7759" device_owner: description: The UUID of the entity that uses this port. returned: success - type: string + type: str sample: "network:router_interface" dns_assignment: description: DNS assignment information. @@ -125,7 +125,7 @@ openstack_ports: dns_name: description: DNS name returned: success - type: string + type: str sample: "" extra_dhcp_opts: description: A set of zero or more extra DHCP option pairs. @@ -141,32 +141,32 @@ openstack_ports: id: description: The UUID of the port. returned: success - type: string + type: str sample: "3ec25c97-7052-4ab8-a8ba-92faf84148de" ip_address: description: The IP address. returned: success - type: string + type: str sample: "127.0.0.1" mac_address: description: The MAC address. returned: success - type: string + type: str sample: "00:00:5E:00:53:42" name: description: The port name. returned: success - type: string + type: str sample: "port_name" network_id: description: The UUID of the attached network. returned: success - type: string + type: str sample: "dd1ede4f-3952-4131-aab6-3b8902268c7d" port_security_enabled: description: The port security status. The status is enabled (true) or disabled (false). returned: success - type: boolean + type: bool sample: false security_groups: description: The UUIDs of any attached security groups. @@ -175,12 +175,12 @@ openstack_ports: status: description: The port status. returned: success - type: string + type: str sample: "ACTIVE" tenant_id: description: The UUID of the tenant who owns the network. returned: success - type: string + type: str sample: "51fce036d7984ba6af4f6c849f65ef00" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_project.py b/lib/ansible/modules/cloud/openstack/os_project.py index 9f197591f5..17922285e5 100644 --- a/lib/ansible/modules/cloud/openstack/os_project.py +++ b/lib/ansible/modules/cloud/openstack/os_project.py @@ -82,15 +82,15 @@ project: contains: id: description: Project ID - type: string + type: str sample: "f59382db809c43139982ca4189404650" name: description: Project name - type: string + type: str sample: "demoproject" description: description: Project description - type: string + type: str sample: "demodescription" enabled: description: Boolean to indicate if project is enabled diff --git a/lib/ansible/modules/cloud/openstack/os_project_access.py b/lib/ansible/modules/cloud/openstack/os_project_access.py index 0675b5a1cd..8aa593aabb 100644 --- a/lib/ansible/modules/cloud/openstack/os_project_access.py +++ b/lib/ansible/modules/cloud/openstack/os_project_access.py @@ -83,12 +83,12 @@ flavor: id: description: Flavor ID. returned: success - type: string + type: str sample: "515256b8-7027-4d73-aa54-4e30a4a4a339" name: description: Flavor name. returned: success - type: string + type: str sample: "tiny" ''' diff --git a/lib/ansible/modules/cloud/openstack/os_project_facts.py b/lib/ansible/modules/cloud/openstack/os_project_facts.py index df476526e0..c6f725b260 100644 --- a/lib/ansible/modules/cloud/openstack/os_project_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_project_facts.py @@ -83,15 +83,15 @@ openstack_projects: id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the project. returned: success - type: string + type: str description: description: Description of the project returned: success - type: string + type: str enabled: description: Flag to indicate if the project is enabled returned: success diff --git a/lib/ansible/modules/cloud/openstack/os_recordset.py b/lib/ansible/modules/cloud/openstack/os_recordset.py index 60e7a91fc8..30248ebf4a 100644 --- a/lib/ansible/modules/cloud/openstack/os_recordset.py +++ b/lib/ansible/modules/cloud/openstack/os_recordset.py @@ -94,23 +94,23 @@ recordset: contains: id: description: Unique recordset ID - type: string + type: str sample: "c1c530a3-3619-46f3-b0f6-236927b2618c" name: description: Recordset name - type: string + type: str sample: "www.example.net." zone_id: description: Zone id - type: string + type: str sample: 9508e177-41d8-434e-962c-6fe6ca880af7 type: description: Recordset type - type: string + type: str sample: "A" description: description: Recordset description - type: string + type: str sample: "Test description" ttl: description: Zone TTL value diff --git a/lib/ansible/modules/cloud/openstack/os_router.py b/lib/ansible/modules/cloud/openstack/os_router.py index 2c90c4bf14..56abc21493 100644 --- a/lib/ansible/modules/cloud/openstack/os_router.py +++ b/lib/ansible/modules/cloud/openstack/os_router.py @@ -169,27 +169,27 @@ router: contains: id: description: Router ID. - type: string + type: str sample: "474acfe5-be34-494c-b339-50f06aa143e4" name: description: Router name. - type: string + type: str sample: "router1" admin_state_up: description: Administrative state of the router. - type: boolean + type: bool sample: true status: description: The router status. - type: string + type: str sample: "ACTIVE" tenant_id: description: The tenant ID. - type: string + type: str sample: "861174b82b43463c9edc5202aadc60ef" external_gateway_info: description: The external gateway parameters. - type: dictionary + type: dict sample: { "enable_snat": true, "external_fixed_ips": [ diff --git a/lib/ansible/modules/cloud/openstack/os_security_group_rule.py b/lib/ansible/modules/cloud/openstack/os_security_group_rule.py index c49c3792a0..b932617969 100644 --- a/lib/ansible/modules/cloud/openstack/os_security_group_rule.py +++ b/lib/ansible/modules/cloud/openstack/os_security_group_rule.py @@ -132,16 +132,16 @@ EXAMPLES = ''' RETURN = ''' id: description: Unique rule UUID. - type: string + type: str returned: state == present direction: description: The direction in which the security group rule is applied. - type: string + type: str sample: 'egress' returned: state == present ethertype: description: One of IPv4 or IPv6. - type: string + type: str sample: 'IPv4' returned: state == present port_range_min: @@ -158,17 +158,17 @@ port_range_max: returned: state == present protocol: description: The protocol that is matched by the security group rule. - type: string + type: str sample: 'tcp' returned: state == present remote_ip_prefix: description: The remote IP prefix to be associated with this security group rule. - type: string + type: str sample: '0.0.0.0/0' returned: state == present security_group_id: description: The security group ID to associate with this security group rule. - type: string + type: str returned: state == present ''' diff --git a/lib/ansible/modules/cloud/openstack/os_server_group.py b/lib/ansible/modules/cloud/openstack/os_server_group.py index 1e5ebc3be0..ef00b107f1 100644 --- a/lib/ansible/modules/cloud/openstack/os_server_group.py +++ b/lib/ansible/modules/cloud/openstack/os_server_group.py @@ -77,11 +77,11 @@ RETURN = ''' id: description: Unique UUID. returned: success - type: string + type: str name: description: The name of the server group. returned: success - type: string + type: str policies: description: A list of one or more policy names of the server group. returned: success @@ -97,11 +97,11 @@ metadata: project_id: description: The project ID who owns the server group. returned: success - type: string + type: str user_id: description: The user ID who owns the server group. returned: success - type: string + type: str ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/cloud/openstack/os_server_metadata.py b/lib/ansible/modules/cloud/openstack/os_server_metadata.py index 5350cc8f1e..5478354655 100644 --- a/lib/ansible/modules/cloud/openstack/os_server_metadata.py +++ b/lib/ansible/modules/cloud/openstack/os_server_metadata.py @@ -87,7 +87,7 @@ RETURN = ''' server_id: description: The compute instance id where the change was made returned: success - type: string + type: str sample: "324c4e91-3e03-4f62-9a4d-06119a8a8d16" metadata: description: The metadata of compute instance after the change diff --git a/lib/ansible/modules/cloud/openstack/os_stack.py b/lib/ansible/modules/cloud/openstack/os_stack.py index b99f806fbf..3b3b20c516 100644 --- a/lib/ansible/modules/cloud/openstack/os_stack.py +++ b/lib/ansible/modules/cloud/openstack/os_stack.py @@ -92,7 +92,7 @@ EXAMPLES = ''' RETURN = ''' id: description: Stack ID. - type: string + type: str sample: "97a3f543-8136-4570-920e-fd7605c989d6" returned: always @@ -103,27 +103,27 @@ stack: contains: action: description: Action, could be Create or Update. - type: string + type: str sample: "CREATE" creation_time: description: Time when the action has been made. - type: string + type: str sample: "2016-07-05T17:38:12Z" description: description: Description of the Stack provided in the heat template. - type: string + type: str sample: "HOT template to create a new instance and networks" id: description: Stack ID. - type: string + type: str sample: "97a3f543-8136-4570-920e-fd7605c989d6" name: description: Name of the Stack - type: string + type: str sample: "test-stack" identifier: description: Identifier of the current Stack action. - type: string + type: str sample: "test-stack/97a3f543-8136-4570-920e-fd7605c989d6" links: description: Links to the current Stack. diff --git a/lib/ansible/modules/cloud/openstack/os_subnets_facts.py b/lib/ansible/modules/cloud/openstack/os_subnets_facts.py index dddefc7cbc..7cbb6892fb 100644 --- a/lib/ansible/modules/cloud/openstack/os_subnets_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_subnets_facts.py @@ -93,23 +93,23 @@ openstack_subnets: id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the subnet. returned: success - type: string + type: str network_id: description: Network ID this subnet belongs in. returned: success - type: string + type: str cidr: description: Subnet's CIDR. returned: success - type: string + type: str gateway_ip: description: Subnet's gateway ip. returned: success - type: string + type: str enable_dhcp: description: DHCP enable flag for this subnet. returned: success @@ -121,7 +121,7 @@ openstack_subnets: tenant_id: description: Tenant id associated with this subnet. returned: success - type: string + type: str dns_nameservers: description: DNS name servers for this subnet. returned: success diff --git a/lib/ansible/modules/cloud/openstack/os_user.py b/lib/ansible/modules/cloud/openstack/os_user.py index 7e2ca3e132..00e44a9214 100644 --- a/lib/ansible/modules/cloud/openstack/os_user.py +++ b/lib/ansible/modules/cloud/openstack/os_user.py @@ -117,23 +117,23 @@ user: contains: default_project_id: description: User default project ID. Only present with Keystone >= v3. - type: string + type: str sample: "4427115787be45f08f0ec22a03bfc735" domain_id: description: User domain ID. Only present with Keystone >= v3. - type: string + type: str sample: "default" email: description: User email address - type: string + type: str sample: "demo@example.com" id: description: User ID - type: string + type: str sample: "f59382db809c43139982ca4189404650" name: description: User name - type: string + type: str sample: "demouser" ''' from distutils.version import StrictVersion diff --git a/lib/ansible/modules/cloud/openstack/os_user_facts.py b/lib/ansible/modules/cloud/openstack/os_user_facts.py index f8f0079030..99bb48b127 100644 --- a/lib/ansible/modules/cloud/openstack/os_user_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_user_facts.py @@ -83,11 +83,11 @@ openstack_users: id: description: Unique UUID. returned: success - type: string + type: str name: description: Name given to the user. returned: success - type: string + type: str enabled: description: Flag to indicate if the user is enabled returned: success @@ -95,19 +95,19 @@ openstack_users: domain_id: description: Domain ID containing the user returned: success - type: string + type: str default_project_id: description: Default project ID of the user returned: success - type: string + type: str email: description: Email of the user returned: success - type: string + type: str username: description: Username of the user returned: success - type: string + type: str ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/cloud/openstack/os_zone.py b/lib/ansible/modules/cloud/openstack/os_zone.py index b7a917a3b8..a0e5392cc1 100644 --- a/lib/ansible/modules/cloud/openstack/os_zone.py +++ b/lib/ansible/modules/cloud/openstack/os_zone.py @@ -89,23 +89,23 @@ zone: contains: id: description: Unique zone ID - type: string + type: str sample: "c1c530a3-3619-46f3-b0f6-236927b2618c" name: description: Zone name - type: string + type: str sample: "example.net." type: description: Zone type - type: string + type: str sample: "PRIMARY" email: description: Zone owner email - type: string + type: str sample: "test@example.net" description: description: Zone description - type: string + type: str sample: "Test description" ttl: description: Zone TTL value diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_api_facts.py b/lib/ansible/modules/cloud/ovirt/ovirt_api_facts.py index 32986db939..ceed55033d 100644 --- a/lib/ansible/modules/cloud/ovirt/ovirt_api_facts.py +++ b/lib/ansible/modules/cloud/ovirt/ovirt_api_facts.py @@ -45,7 +45,7 @@ ovirt_api: all API attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/api." returned: On success. - type: dictionary + type: dict ''' import traceback diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_auth.py b/lib/ansible/modules/cloud/ovirt/ovirt_auth.py index 64c77a08f5..407ee88033 100644 --- a/lib/ansible/modules/cloud/ovirt/ovirt_auth.py +++ b/lib/ansible/modules/cloud/ovirt/ovirt_auth.py @@ -159,12 +159,12 @@ ovirt_auth: token: description: SSO token which is used for connection to oVirt/RHV engine. returned: success - type: string + type: str sample: "kdfVWp9ZgeewBXV-iq3Js1-xQJZPSEQ334FLb3eksoEPRaab07DhZ8ED8ghz9lJd-MQ2GqtRIeqhvhCkrUWQPw" url: description: URL of the oVirt/RHV engine API endpoint. returned: success - type: string + type: str sample: "https://ovirt.example.com/ovirt-engine/api" ca_file: description: CA file, which is used to verify SSL/TLS connection. diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_external_provider.py b/lib/ansible/modules/cloud/ovirt/ovirt_external_provider.py index 298b11caaa..f36d5a4a9f 100644 --- a/lib/ansible/modules/cloud/ovirt/ovirt_external_provider.py +++ b/lib/ansible/modules/cloud/ovirt/ovirt_external_provider.py @@ -159,22 +159,22 @@ external_host_provider: description: "Dictionary of all the external_host_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/external_host_provider." returned: "On success and if parameter 'type: foreman' is used." - type: dictionary + type: dict openstack_image_provider: description: "Dictionary of all the openstack_image_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_image_provider." returned: "On success and if parameter 'type: os_image' is used." - type: dictionary + type: dict openstack_volume_provider: description: "Dictionary of all the openstack_volume_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_volume_provider." returned: "On success and if parameter 'type: os_volume' is used." - type: dictionary + type: dict openstack_network_provider: description: "Dictionary of all the openstack_network_provider attributes. External provider attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/openstack_network_provider." returned: "On success and if parameter 'type: network' is used." - type: dictionary + type: dict ''' import traceback diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_storage_connection.py b/lib/ansible/modules/cloud/ovirt/ovirt_storage_connection.py index 465938dcd6..3da3156f57 100644 --- a/lib/ansible/modules/cloud/ovirt/ovirt_storage_connection.py +++ b/lib/ansible/modules/cloud/ovirt/ovirt_storage_connection.py @@ -100,7 +100,7 @@ RETURN = ''' id: description: ID of the storage connection which is managed returned: On success if storage connection is found. - type: string + type: str sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c storage_connection: description: "Dictionary of all the storage connection attributes. Storage connection attributes can be found on your oVirt instance diff --git a/lib/ansible/modules/cloud/smartos/imgadm.py b/lib/ansible/modules/cloud/smartos/imgadm.py index 30f629b7e0..957302400b 100644 --- a/lib/ansible/modules/cloud/smartos/imgadm.py +++ b/lib/ansible/modules/cloud/smartos/imgadm.py @@ -99,17 +99,17 @@ RETURN = ''' source: description: Source that is managed. returned: When not managing an image. - type: string + type: str sample: https://datasets.project-fifo.net uuid: description: UUID for an image operated on. returned: When not managing an image source. - type: string + type: str sample: 70e3ae72-96b6-11e6-9056-9737fd4d0764 state: description: State of the target, after execution. returned: success - type: string + type: str sample: 'present' ''' diff --git a/lib/ansible/modules/cloud/smartos/vmadm.py b/lib/ansible/modules/cloud/smartos/vmadm.py index 11598ef8ee..08fd81e86d 100644 --- a/lib/ansible/modules/cloud/smartos/vmadm.py +++ b/lib/ansible/modules/cloud/smartos/vmadm.py @@ -326,17 +326,17 @@ RETURN = ''' uuid: description: UUID of the managed VM. returned: always - type: string + type: str sample: 'b217ab0b-cf57-efd8-cd85-958d0b80be33' alias: description: Alias of the managed VM. returned: When addressing a VM by alias. - type: string + type: str sample: 'dns-zone' state: description: State of the target, after execution. returned: success - type: string + type: str sample: 'running' ''' diff --git a/lib/ansible/modules/cloud/spotinst/spotinst_aws_elastigroup.py b/lib/ansible/modules/cloud/spotinst/spotinst_aws_elastigroup.py index dc92444b60..9803789d11 100644 --- a/lib/ansible/modules/cloud/spotinst/spotinst_aws_elastigroup.py +++ b/lib/ansible/modules/cloud/spotinst/spotinst_aws_elastigroup.py @@ -742,7 +742,7 @@ instances: group_id: description: Created / Updated group's ID. returned: success - type: string + type: str sample: "sig-12345" ''' diff --git a/lib/ansible/modules/cloud/vmware/vcenter_extension.py b/lib/ansible/modules/cloud/vmware/vcenter_extension.py index 84d2972ea8..2c7c05d193 100644 --- a/lib/ansible/modules/cloud/vmware/vcenter_extension.py +++ b/lib/ansible/modules/cloud/vmware/vcenter_extension.py @@ -107,7 +107,7 @@ RETURN = """ result: description: information about performed operation returned: always - type: string + type: str sample: "'com.acme.Extension' installed." """ diff --git a/lib/ansible/modules/cloud/vmware/vcenter_folder.py b/lib/ansible/modules/cloud/vmware/vcenter_folder.py index ea6aab1525..0e10aa1bca 100644 --- a/lib/ansible/modules/cloud/vmware/vcenter_folder.py +++ b/lib/ansible/modules/cloud/vmware/vcenter_folder.py @@ -125,7 +125,7 @@ result: description: - string stating about result returned: success - type: string + type: str sample: "Folder 'sub_network_folder' of type 'vm' created under vm_folder successfully." ''' diff --git a/lib/ansible/modules/cloud/vmware/vmware_about_facts.py b/lib/ansible/modules/cloud/vmware/vmware_about_facts.py index b9e807e592..deb240cbbd 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_about_facts.py +++ b/lib/ansible/modules/cloud/vmware/vmware_about_facts.py @@ -54,7 +54,7 @@ about_facts: description: - dict about VMware server returned: success - type: string + type: str sample: { "api_type": "VirtualCenter", diff --git a/lib/ansible/modules/cloud/vmware/vmware_cfg_backup.py b/lib/ansible/modules/cloud/vmware/vmware_cfg_backup.py index 9f515eca7f..26eb0840dd 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_cfg_backup.py +++ b/lib/ansible/modules/cloud/vmware/vmware_cfg_backup.py @@ -75,7 +75,7 @@ RETURN = ''' dest_file: description: The full path of where the file holding the ESXi configurations was stored returned: changed - type: string + type: str sample: /tmp/configBundle-esxi.host.domain.tgz ''' diff --git a/lib/ansible/modules/cloud/vmware/vmware_datastore_cluster.py b/lib/ansible/modules/cloud/vmware/vmware_datastore_cluster.py index 4e635ef511..87e1c41cf8 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_datastore_cluster.py +++ b/lib/ansible/modules/cloud/vmware/vmware_datastore_cluster.py @@ -74,7 +74,7 @@ RETURN = """ result: description: information about datastore cluster operation returned: always - type: string + type: str sample: "Datastore cluster 'DSC2' created successfully." """ diff --git a/lib/ansible/modules/cloud/vmware/vmware_dvswitch.py b/lib/ansible/modules/cloud/vmware/vmware_dvswitch.py index b8201385f3..c02388f268 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_dvswitch.py +++ b/lib/ansible/modules/cloud/vmware/vmware_dvswitch.py @@ -196,7 +196,7 @@ RETURN = """ result: description: information about performed operation returned: always - type: string + type: str sample: { "changed": false, "contact": null, diff --git a/lib/ansible/modules/cloud/vmware/vmware_dvswitch_lacp.py b/lib/ansible/modules/cloud/vmware/vmware_dvswitch_lacp.py index 70db65dcf5..b735c9f8b8 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_dvswitch_lacp.py +++ b/lib/ansible/modules/cloud/vmware/vmware_dvswitch_lacp.py @@ -120,7 +120,7 @@ RETURN = """ result: description: information about performed operation returned: always - type: string + type: str sample: { "changed": true, "dvswitch": "dvSwitch", diff --git a/lib/ansible/modules/cloud/vmware/vmware_dvswitch_pvlans.py b/lib/ansible/modules/cloud/vmware/vmware_dvswitch_pvlans.py index 8794997c30..1ae7867693 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_dvswitch_pvlans.py +++ b/lib/ansible/modules/cloud/vmware/vmware_dvswitch_pvlans.py @@ -105,7 +105,7 @@ RETURN = """ result: description: information about performed operation returned: always - type: string + type: str sample: { "changed": true, "dvswitch": "dvSwitch", diff --git a/lib/ansible/modules/cloud/vmware/vmware_guest.py b/lib/ansible/modules/cloud/vmware/vmware_guest.py index 61e5b51d55..55300b2dc4 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_guest.py +++ b/lib/ansible/modules/cloud/vmware/vmware_guest.py @@ -516,7 +516,7 @@ EXAMPLES = r''' - id: remoteIP category: Backup label: Backup server IP - type: string + type: str value: 10.10.10.1 - id: old_property operation: remove diff --git a/lib/ansible/modules/cloud/vmware/vmware_local_role_manager.py b/lib/ansible/modules/cloud/vmware/vmware_local_role_manager.py index 85fd825fc9..9cf1cd8682 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_local_role_manager.py +++ b/lib/ansible/modules/cloud/vmware/vmware_local_role_manager.py @@ -129,7 +129,7 @@ RETURN = r''' role_name: description: Name of local role returned: always - type: string + type: str role_id: description: ESXi generated local role id returned: always diff --git a/lib/ansible/modules/cloud/vmware/vmware_maintenancemode.py b/lib/ansible/modules/cloud/vmware/vmware_maintenancemode.py index 71a36e895b..74606d06b1 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_maintenancemode.py +++ b/lib/ansible/modules/cloud/vmware/vmware_maintenancemode.py @@ -85,17 +85,17 @@ RETURN = ''' hostsystem: description: Name of vim reference returned: always - type: string + type: str sample: "'vim.HostSystem:host-236'" hostname: description: Name of host in vCenter returned: always - type: string + type: str sample: "esxi.local.domain" status: description: Action taken returned: always - type: string + type: str sample: "ENTER" ''' diff --git a/lib/ansible/modules/cloud/vmware/vmware_vmotion.py b/lib/ansible/modules/cloud/vmware/vmware_vmotion.py index 05e861ce4a..fede1ac988 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_vmotion.py +++ b/lib/ansible/modules/cloud/vmware/vmware_vmotion.py @@ -97,7 +97,7 @@ RETURN = ''' running_host: description: List the host the virtual machine is registered to returned: changed or success - type: string + type: str sample: 'host1.example.com' ''' diff --git a/lib/ansible/modules/cloud/vmware/vmware_vswitch.py b/lib/ansible/modules/cloud/vmware/vmware_vswitch.py index 40f56e7b91..fd73db88a9 100644 --- a/lib/ansible/modules/cloud/vmware/vmware_vswitch.py +++ b/lib/ansible/modules/cloud/vmware/vmware_vswitch.py @@ -114,7 +114,7 @@ RETURN = """ result: description: information about performed operation returned: always - type: string + type: str sample: "vSwitch 'vSwitch_1002' is created successfully" """ diff --git a/lib/ansible/modules/cloud/vultr/vultr_account_facts.py b/lib/ansible/modules/cloud/vultr/vultr_account_facts.py index e2aa33c14f..0c96731d42 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_account_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_account_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_account_facts: description: Response from Vultr API @@ -77,7 +77,7 @@ vultr_account_facts: last_payment_date: description: Date of the last payment. returned: success - type: string + type: str sample: "2017-08-26 12:47:48" last_payment_amount: description: The amount of the last payment transaction. diff --git a/lib/ansible/modules/cloud/vultr/vultr_block_storage.py b/lib/ansible/modules/cloud/vultr/vultr_block_storage.py index c383dde819..b17cb924c5 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_block_storage.py +++ b/lib/ansible/modules/cloud/vultr/vultr_block_storage.py @@ -66,7 +66,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -81,7 +81,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_block_storage: description: Response from Vultr API @@ -91,7 +91,7 @@ vultr_block_storage: attached_to_id: description: The ID of the server the volume is attached to returned: success - type: string + type: str sample: "10194376" cost_per_month: description: Cost per month for the volume @@ -101,22 +101,22 @@ vultr_block_storage: date_created: description: Date when the volume was created returned: success - type: string + type: str sample: "2017-08-26 12:47:48" id: description: ID of the block storage volume returned: success - type: string + type: str sample: "1234abcd" name: description: Name of the volume returned: success - type: string + type: str sample: "ansible-test-volume" region: description: Region the volume was deployed into returned: success - type: string + type: str sample: "New Jersey" size: description: Information about the volume size in GB @@ -126,7 +126,7 @@ vultr_block_storage: status: description: Status about the deployment of the volume returned: success - type: string + type: str sample: "active" ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_block_storage_facts.py b/lib/ansible/modules/cloud/vultr/vultr_block_storage_facts.py index df15845604..61f6f7ca62 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_block_storage_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_block_storage_facts.py @@ -41,7 +41,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -56,7 +56,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_block_storage_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_dns_domain.py b/lib/ansible/modules/cloud/vultr/vultr_dns_domain.py index 6d63c0c86f..985f13cbf2 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_dns_domain.py +++ b/lib/ansible/modules/cloud/vultr/vultr_dns_domain.py @@ -62,7 +62,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -77,7 +77,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_dns_domain: description: Response from Vultr API @@ -87,12 +87,12 @@ vultr_dns_domain: name: description: Name of the DNS Domain. returned: success - type: string + type: str sample: example.com date_created: description: Date the DNS domain was created. returned: success - type: string + type: str sample: "2017-08-26 12:47:48" ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_dns_domain_facts.py b/lib/ansible/modules/cloud/vultr/vultr_dns_domain_facts.py index cfd61866b9..58c4706ed0 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_dns_domain_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_dns_domain_facts.py @@ -41,7 +41,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -56,7 +56,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_dns_domain_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_dns_record.py b/lib/ansible/modules/cloud/vultr/vultr_dns_record.py index 94ab81c115..d341c8c286 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_dns_record.py +++ b/lib/ansible/modules/cloud/vultr/vultr_dns_record.py @@ -132,7 +132,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -152,22 +152,22 @@ vultr_dns_record: name: description: The name of the DNS record. returned: success - type: string + type: str sample: web record_type: description: The name of the DNS record. returned: success - type: string + type: str sample: web data: description: Data of the DNS record. returned: success - type: string + type: str sample: 10.10.10.10 domain: description: Domain the DNS record is related to. returned: success - type: string + type: str sample: example.com priority: description: Priority of the DNS record. diff --git a/lib/ansible/modules/cloud/vultr/vultr_firewall_group.py b/lib/ansible/modules/cloud/vultr/vultr_firewall_group.py index 5c455cbb73..51cd123cb8 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_firewall_group.py +++ b/lib/ansible/modules/cloud/vultr/vultr_firewall_group.py @@ -56,7 +56,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -71,7 +71,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_firewall_group: description: Response from Vultr API @@ -81,22 +81,22 @@ vultr_firewall_group: id: description: ID of the firewall group returned: success - type: string + type: str sample: 1234abcd name: description: Name of the firewall group returned: success - type: string + type: str sample: my firewall group date_created: description: Date the firewall group was created returned: success - type: string + type: str sample: "2017-08-26 12:47:48" date_modified: description: Date the firewall group was modified returned: success - type: string + type: str sample: "2017-08-26 12:47:48" ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_firewall_group_facts.py b/lib/ansible/modules/cloud/vultr/vultr_firewall_group_facts.py index 9be3f02809..44f900d50c 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_firewall_group_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_firewall_group_facts.py @@ -41,7 +41,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -56,7 +56,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_firewall_group_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_firewall_rule.py b/lib/ansible/modules/cloud/vultr/vultr_firewall_rule.py index c66f2c5594..c1fc9cdd10 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_firewall_rule.py +++ b/lib/ansible/modules/cloud/vultr/vultr_firewall_rule.py @@ -104,7 +104,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -119,7 +119,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_firewall_rule: description: Response from Vultr API @@ -134,12 +134,12 @@ vultr_firewall_rule: action: description: Action of the firewall rule returned: success - type: string + type: str sample: accept protocol: description: Protocol of the firewall rule returned: success - type: string + type: str sample: tcp start_port: description: Start port of the firewall rule @@ -154,12 +154,12 @@ vultr_firewall_rule: cidr: description: CIDR of the firewall rule (IPv4 or IPv6) returned: success and when port range - type: string + type: str sample: 0.0.0.0/0 group: description: Firewall group the rule is into. returned: success - type: string + type: str sample: web ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_network.py b/lib/ansible/modules/cloud/vultr/vultr_network.py index e0597da520..df01b4c43a 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_network.py +++ b/lib/ansible/modules/cloud/vultr/vultr_network.py @@ -64,7 +64,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -79,7 +79,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_network: description: Response from Vultr API @@ -89,27 +89,27 @@ vultr_network: id: description: ID of the network returned: success - type: string + type: str sample: "net5b62c6dc63ef5" name: description: Name (label) of the network returned: success - type: string + type: str sample: "mynetwork" date_created: description: Date when the network was created returned: success - type: string + type: str sample: "2018-08-02 08:54:52" region: description: Region the network was deployed into returned: success - type: string + type: str sample: "Amsterdam" v4_subnet: description: IPv4 Network address returned: success - type: string + type: str sample: "192.168.42.0" v4_subnet_mask: description: Ipv4 Network mask diff --git a/lib/ansible/modules/cloud/vultr/vultr_network_facts.py b/lib/ansible/modules/cloud/vultr/vultr_network_facts.py index fd2c69902c..2977f4ed56 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_network_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_network_facts.py @@ -41,7 +41,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -56,7 +56,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_network_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_os_facts.py b/lib/ansible/modules/cloud/vultr/vultr_os_facts.py index 99e9b2ed01..0002510f5a 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_os_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_os_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" ansible_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_plan_facts.py b/lib/ansible/modules/cloud/vultr/vultr_plan_facts.py index fcb542d226..9366c0c1d2 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_plan_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_plan_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_plan_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_region_facts.py b/lib/ansible/modules/cloud/vultr/vultr_region_facts.py index 17844a7485..f311297204 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_region_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_region_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_region_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_server.py b/lib/ansible/modules/cloud/vultr/vultr_server.py index 9bdbc4baf6..8e53373ff1 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_server.py +++ b/lib/ansible/modules/cloud/vultr/vultr_server.py @@ -149,7 +149,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -164,7 +164,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_server: description: Response from Vultr API with a few additions/modification @@ -174,17 +174,17 @@ vultr_server: id: description: ID of the server returned: success - type: string + type: str sample: 10194376 name: description: Name (label) of the server returned: success - type: string + type: str sample: "ansible-test-vm" plan: description: Plan used for the server returned: success - type: string + type: str sample: "1024 MB RAM,25 GB SSD,1.00 TB BW" allowed_bandwidth_gb: description: Allowed bandwidth to use in GB @@ -209,57 +209,57 @@ vultr_server: date_created: description: Date when the server was created returned: success - type: string + type: str sample: "2017-08-26 12:47:48" default_password: description: Password to login as root into the server returned: success - type: string + type: str sample: "!p3EWYJm$qDWYaFr" disk: description: Information about the disk returned: success - type: string + type: str sample: "Virtual 25 GB" v4_gateway: description: IPv4 gateway returned: success - type: string + type: str sample: "45.32.232.1" internal_ip: description: Internal IP returned: success - type: string + type: str sample: "" kvm_url: description: URL to the VNC returned: success - type: string + type: str sample: "https://my.vultr.com/subs/vps/novnc/api.php?data=xyz" region: description: Region the server was deployed into returned: success - type: string + type: str sample: "Amsterdam" v4_main_ip: description: Main IPv4 returned: success - type: string + type: str sample: "45.32.233.154" v4_netmask: description: Netmask IPv4 returned: success - type: string + type: str sample: "255.255.254.0" os: description: Operating system used for the server returned: success - type: string + type: str sample: "CentOS 6 x64" firewall_group: description: Firewall group the server is assinged to returned: success and available - type: string + type: str sample: "CentOS 6 x64" pending_charges: description: Pending charges @@ -269,42 +269,42 @@ vultr_server: power_status: description: Power status of the server returned: success - type: string + type: str sample: "running" ram: description: Information about the RAM size returned: success - type: string + type: str sample: "1024 MB" server_state: description: State about the server returned: success - type: string + type: str sample: "ok" status: description: Status about the deployment of the server returned: success - type: string + type: str sample: "active" tag: description: TBD returned: success - type: string + type: str sample: "" v6_main_ip: description: Main IPv6 returned: success - type: string + type: str sample: "" v6_network: description: Network IPv6 returned: success - type: string + type: str sample: "" v6_network_size: description: Network size IPv6 returned: success - type: string + type: str sample: "" v6_networks: description: Networks IPv6 diff --git a/lib/ansible/modules/cloud/vultr/vultr_server_facts.py b/lib/ansible/modules/cloud/vultr/vultr_server_facts.py index 2495e1e4ad..b94ef87c54 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_server_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_server_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_server_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_ssh_key.py b/lib/ansible/modules/cloud/vultr/vultr_ssh_key.py index 45be4cc601..cc71de6d69 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_ssh_key.py +++ b/lib/ansible/modules/cloud/vultr/vultr_ssh_key.py @@ -61,7 +61,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -76,7 +76,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_ssh_key: description: Response from Vultr API @@ -86,22 +86,22 @@ vultr_ssh_key: id: description: ID of the ssh key returned: success - type: string + type: str sample: 5904bc6ed9234 name: description: Name of the ssh key returned: success - type: string + type: str sample: my ssh key date_created: description: Date the ssh key was created returned: success - type: string + type: str sample: "2017-08-26 12:47:48" ssh_key: description: SSH public key returned: success - type: string + type: str sample: "ssh-rsa AA... someother@example.com" ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_ssh_key_facts.py b/lib/ansible/modules/cloud/vultr/vultr_ssh_key_facts.py index 0f7a02716c..1868268357 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_ssh_key_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_ssh_key_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" ansible_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_startup_script.py b/lib/ansible/modules/cloud/vultr/vultr_startup_script.py index 95af6a9c57..b5115970ea 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_startup_script.py +++ b/lib/ansible/modules/cloud/vultr/vultr_startup_script.py @@ -73,7 +73,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -88,7 +88,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_startup_script: description: Response from Vultr API @@ -98,32 +98,32 @@ vultr_startup_script: id: description: ID of the startup script. returned: success - type: string + type: str sample: 249395 name: description: Name of the startup script. returned: success - type: string + type: str sample: my startup script script: description: The source code of the startup script. returned: success - type: string + type: str sample: "#!/bin/bash\necho Hello World > /root/hello" script_type: description: The type of the startup script. returned: success - type: string + type: str sample: pxe date_created: description: Date the startup script was created. returned: success - type: string + type: str sample: "2017-08-26 12:47:48" date_modified: description: Date the startup script was modified. returned: success - type: string + type: str sample: "2017-08-26 12:47:48" ''' diff --git a/lib/ansible/modules/cloud/vultr/vultr_startup_script_facts.py b/lib/ansible/modules/cloud/vultr/vultr_startup_script_facts.py index 6ecfa4ba46..cc41da43d1 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_startup_script_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_startup_script_facts.py @@ -42,7 +42,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -57,7 +57,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_startup_script_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/cloud/vultr/vultr_user.py b/lib/ansible/modules/cloud/vultr/vultr_user.py index 5bca213308..65cfa420f0 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_user.py +++ b/lib/ansible/modules/cloud/vultr/vultr_user.py @@ -96,7 +96,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -111,7 +111,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_user: description: Response from Vultr API @@ -121,22 +121,22 @@ vultr_user: id: description: ID of the user. returned: success - type: string + type: str sample: 5904bc6ed9234 api_key: description: API key of the user. returned: only after resource was created - type: string + type: str sample: 567E6K567E6K567E6K567E6K567E6K name: description: Name of the user. returned: success - type: string + type: str sample: john email: description: Email of the user. returned: success - type: string + type: str sample: "john@exmaple.com" api_enabled: description: Whether the API is enabled or not. diff --git a/lib/ansible/modules/cloud/vultr/vultr_user_facts.py b/lib/ansible/modules/cloud/vultr/vultr_user_facts.py index 0d8d4ff34b..ae4324137f 100644 --- a/lib/ansible/modules/cloud/vultr/vultr_user_facts.py +++ b/lib/ansible/modules/cloud/vultr/vultr_user_facts.py @@ -41,7 +41,7 @@ vultr_api: api_account: description: Account used in the ini file to select the key returned: success - type: string + type: str sample: default api_timeout: description: Timeout used for the API requests @@ -56,7 +56,7 @@ vultr_api: api_endpoint: description: Endpoint used for the API requests returned: success - type: string + type: str sample: "https://api.vultr.com" vultr_user_facts: description: Response from Vultr API diff --git a/lib/ansible/modules/clustering/consul_acl.py b/lib/ansible/modules/clustering/consul_acl.py index 7268b32615..8d1d93bf0a 100644 --- a/lib/ansible/modules/clustering/consul_acl.py +++ b/lib/ansible/modules/clustering/consul_acl.py @@ -138,13 +138,13 @@ RETURN = """ token: description: the token associated to the ACL (the ACL's ID) returned: success - type: string + type: str sample: a2ec332f-04cf-6fba-e8b8-acf62444d3da rules: description: the HCL JSON representation of the rules associated to the ACL, in the format described in the Consul documentation (https://www.consul.io/docs/guides/acl.html#rule-specification). returned: I(status) == "present" - type: string + type: str sample: { "key": { "foo": { @@ -158,7 +158,7 @@ rules: operation: description: the operation performed on the ACL returned: changed - type: string + type: str sample: update """ diff --git a/lib/ansible/modules/clustering/openshift/_oc.py b/lib/ansible/modules/clustering/openshift/_oc.py index 3dd8d5e1ee..b5529d7b2c 100644 --- a/lib/ansible/modules/clustering/openshift/_oc.py +++ b/lib/ansible/modules/clustering/openshift/_oc.py @@ -128,15 +128,15 @@ result: The resource that was created, changed, or otherwise determined to be present. In the case of a deletion, this is the response from the delete request. returned: success - type: string + type: str url: description: The URL to the requested resource. returned: success - type: string + type: str method: description: The HTTP method that was used to take action upon the resource returned: success - type: string + type: str ... ''' diff --git a/lib/ansible/modules/clustering/pacemaker_cluster.py b/lib/ansible/modules/clustering/pacemaker_cluster.py index 2503125616..8451fafc3c 100644 --- a/lib/ansible/modules/clustering/pacemaker_cluster.py +++ b/lib/ansible/modules/clustering/pacemaker_cluster.py @@ -60,7 +60,7 @@ changed: out: description: The output of the current state of the cluster. It return a list of the nodes state. - type: string + type: str sample: 'out: [[" overcloud-controller-0", " Online"]]}' returned: always rc: diff --git a/lib/ansible/modules/commands/command.py b/lib/ansible/modules/commands/command.py index 1b45ae0705..010bd347ac 100644 --- a/lib/ansible/modules/commands/command.py +++ b/lib/ansible/modules/commands/command.py @@ -124,17 +124,17 @@ cmd: delta: description: cmd end time - cmd start time returned: always - type: string + type: str sample: 0:00:00.001529 end: description: cmd end time returned: always - type: string + type: str sample: '2017-09-29 22:03:48.084657' start: description: cmd start time returned: always - type: string + type: str sample: '2017-09-29 22:03:48.083128' ''' diff --git a/lib/ansible/modules/commands/shell.py b/lib/ansible/modules/commands/shell.py index 1c13cf3d07..6a5d64b969 100644 --- a/lib/ansible/modules/commands/shell.py +++ b/lib/ansible/modules/commands/shell.py @@ -146,37 +146,37 @@ RETURN = r''' msg: description: changed returned: always - type: boolean + type: bool sample: True start: description: The command execution start time returned: always - type: string + type: str sample: '2016-02-25 09:18:26.429568' end: description: The command execution end time returned: always - type: string + type: str sample: '2016-02-25 09:18:26.755339' delta: description: The command execution delta time returned: always - type: string + type: str sample: '0:00:00.325771' stdout: description: The command standard output returned: always - type: string + type: str sample: 'Clustering node rabbit@slave1 with rabbit@master ...' stderr: description: The command standard error returned: always - type: string + type: str sample: 'ls: cannot access foo: No such file or directory' cmd: description: The command executed by the task returned: always - type: string + type: str sample: 'rabbitmqctl join_cluster rabbit@master' rc: description: The command return code (0 means success) diff --git a/lib/ansible/modules/crypto/acme/acme_account.py b/lib/ansible/modules/crypto/acme/acme_account.py index b49eec02e2..a07f4c8889 100644 --- a/lib/ansible/modules/crypto/acme/acme_account.py +++ b/lib/ansible/modules/crypto/acme/acme_account.py @@ -114,7 +114,7 @@ RETURN = ''' account_uri: description: ACME account URI, or None if account does not exist. returned: always - type: string + type: str ''' from ansible.module_utils.acme import ( diff --git a/lib/ansible/modules/crypto/acme/acme_account_facts.py b/lib/ansible/modules/crypto/acme/acme_account_facts.py index 0e68483a8d..4a50efcff4 100644 --- a/lib/ansible/modules/crypto/acme/acme_account_facts.py +++ b/lib/ansible/modules/crypto/acme/acme_account_facts.py @@ -66,7 +66,7 @@ exists: account_uri: description: ACME account URI, or None if account does not exist. returned: always - type: string + type: str account: description: The account information, as retrieved from the ACME server. diff --git a/lib/ansible/modules/crypto/acme/acme_certificate.py b/lib/ansible/modules/crypto/acme/acme_certificate.py index 8719b3b0cb..dfbf5ceb77 100644 --- a/lib/ansible/modules/crypto/acme/acme_certificate.py +++ b/lib/ansible/modules/crypto/acme/acme_certificate.py @@ -281,7 +281,7 @@ challenge_data: resource: description: the challenge resource that must be created for validation returned: changed - type: string + type: str sample: .well-known/acme-challenge/evaGxfADs6pSRb2LAv9IZf17Dt3juxGJ-PCt92wr-oA resource_value: description: @@ -294,12 +294,12 @@ challenge_data: for details. To do this, you might need the C(b64decode) Jinja filter to extract the binary blob from this return value." returned: changed - type: string + type: str sample: IlirfxKKXA...17Dt3juxGJ-PCt92wr-oA record: description: the full DNS record's name for the challenge returned: changed and challenge is C(dns-01) - type: string + type: str sample: _acme-challenge.example.com version_added: "2.5" challenge_data_dns: @@ -319,17 +319,17 @@ authorizations: order_uri: description: ACME order URI. returned: changed - type: string + type: str version_added: "2.5" finalization_uri: description: ACME finalization URI. returned: changed - type: string + type: str version_added: "2.5" account_uri: description: ACME account URI. returned: changed - type: string + type: str version_added: "2.5" ''' diff --git a/lib/ansible/modules/crypto/acme/acme_challenge_cert_helper.py b/lib/ansible/modules/crypto/acme/acme_challenge_cert_helper.py index 9ef0570341..6efd6823c7 100644 --- a/lib/ansible/modules/crypto/acme/acme_challenge_cert_helper.py +++ b/lib/ansible/modules/crypto/acme/acme_challenge_cert_helper.py @@ -97,12 +97,12 @@ domain: description: - "The domain the challenge is for." returned: always - type: string + type: str challenge_certificate: description: - "The challenge certificate in PEM format." returned: always - type: string + type: str regular_certificate: description: - "A self-signed certificate for the challenge domain." @@ -110,7 +110,7 @@ regular_certificate: https in the first place if that is needed for providing the challenge." returned: always - type: string + type: str ''' from ansible.module_utils.acme import ( diff --git a/lib/ansible/modules/crypto/acme/acme_inspect.py b/lib/ansible/modules/crypto/acme/acme_inspect.py index 65abfaccde..89007364e1 100644 --- a/lib/ansible/modules/crypto/acme/acme_inspect.py +++ b/lib/ansible/modules/crypto/acme/acme_inspect.py @@ -224,7 +224,7 @@ headers: output_text: description: The raw text output returned: always - type: string + type: str sample: "{\\n \\\"id\\\": 12345,\\n \\\"key\\\": {\\n \\\"kty\\\": \\\"RSA\\\",\\n ..." output_json: description: The output parsed as JSON diff --git a/lib/ansible/modules/crypto/certificate_complete_chain.py b/lib/ansible/modules/crypto/certificate_complete_chain.py index 4f8b01ed06..c0855339f7 100644 --- a/lib/ansible/modules/crypto/certificate_complete_chain.py +++ b/lib/ansible/modules/crypto/certificate_complete_chain.py @@ -105,7 +105,7 @@ root: description: - "The root certificate in PEM format." returned: success - type: string + type: str chain: description: - "The chain added to the given input chain. Includes the root certificate." diff --git a/lib/ansible/modules/crypto/get_certificate.py b/lib/ansible/modules/crypto/get_certificate.py index c1246b6522..61ff9cb455 100644 --- a/lib/ansible/modules/crypto/get_certificate.py +++ b/lib/ansible/modules/crypto/get_certificate.py @@ -50,7 +50,7 @@ RETURN = ''' cert: description: The certificate retrieved from the port returned: success - type: string + type: str expired: description: Boolean indicating if the cert is expired returned: success @@ -66,19 +66,19 @@ issuer: not_after: description: Expiration date of the cert returned: success - type: string + type: str not_before: description: Issue date of the cert returned: success - type: string + type: str serial_number: description: The serial number of the cert returned: success - type: string + type: str signature_algorithm: description: The algorithm used to sign the cert returned: success - type: string + type: str subject: description: Information about the subject of the cert (OU, CN, etc) returned: success @@ -86,7 +86,7 @@ subject: version: description: The version number of the certificate returned: success - type: string + type: str ''' EXAMPLES = ''' diff --git a/lib/ansible/modules/crypto/openssh_keypair.py b/lib/ansible/modules/crypto/openssh_keypair.py index a298ad47a6..cfb3e14e2c 100644 --- a/lib/ansible/modules/crypto/openssh_keypair.py +++ b/lib/ansible/modules/crypto/openssh_keypair.py @@ -96,17 +96,17 @@ size: type: description: Algorithm used to generate the SSH private key returned: changed or success - type: string + type: str sample: rsa filename: description: Path to the generated SSH private key file returned: changed or success - type: string + type: str sample: /tmp/id_ssh_rsa fingerprint: description: The fingerprint of the key. returned: changed or success - type: string + type: str sample: 4096 SHA256:r4YCZxihVjedH2OlfjVGI6Y5xAYtdCwk8VxKyzVyYfM example@example.com (RSA) ''' diff --git a/lib/ansible/modules/crypto/openssl_certificate.py b/lib/ansible/modules/crypto/openssl_certificate.py index 3084b09441..89fdc20358 100644 --- a/lib/ansible/modules/crypto/openssl_certificate.py +++ b/lib/ansible/modules/crypto/openssl_certificate.py @@ -391,7 +391,7 @@ RETURN = ''' filename: description: Path to the generated Certificate returned: changed or success - type: string + type: str sample: /etc/ssl/crt/www.ansible.com.crt ''' diff --git a/lib/ansible/modules/crypto/openssl_csr.py b/lib/ansible/modules/crypto/openssl_csr.py index 0baf7eb661..77631ce16a 100644 --- a/lib/ansible/modules/crypto/openssl_csr.py +++ b/lib/ansible/modules/crypto/openssl_csr.py @@ -249,12 +249,12 @@ RETURN = ''' privatekey: description: Path to the TLS/SSL private key the CSR was generated for returned: changed or success - type: string + type: str sample: /etc/ssl/private/ansible.com.pem filename: description: Path to the generated Certificate Signing Request returned: changed or success - type: string + type: str sample: /etc/ssl/csr/www.ansible.com.csr subject: description: A list of the subject tuples attached to the CSR diff --git a/lib/ansible/modules/crypto/openssl_dhparam.py b/lib/ansible/modules/crypto/openssl_dhparam.py index 849477c1f8..cdcb5f789e 100644 --- a/lib/ansible/modules/crypto/openssl_dhparam.py +++ b/lib/ansible/modules/crypto/openssl_dhparam.py @@ -76,7 +76,7 @@ size: filename: description: Path to the generated Diffie-Hellman parameters returned: changed or success - type: string + type: str sample: /etc/ssl/dhparams.pem ''' diff --git a/lib/ansible/modules/crypto/openssl_pkcs12.py b/lib/ansible/modules/crypto/openssl_pkcs12.py index dc904f5957..15bbde0b31 100644 --- a/lib/ansible/modules/crypto/openssl_pkcs12.py +++ b/lib/ansible/modules/crypto/openssl_pkcs12.py @@ -129,12 +129,12 @@ RETURN = ''' filename: description: Path to the generate PKCS#12 file. returned: changed or success - type: string + type: str sample: /opt/certs/ansible.p12 privatekey: description: Path to the TLS/SSL private key the public key was generated from returned: changed or success - type: string + type: str sample: /etc/ssl/private/ansible.com.pem ''' diff --git a/lib/ansible/modules/crypto/openssl_privatekey.py b/lib/ansible/modules/crypto/openssl_privatekey.py index b25ba225f8..fbebad0371 100644 --- a/lib/ansible/modules/crypto/openssl_privatekey.py +++ b/lib/ansible/modules/crypto/openssl_privatekey.py @@ -163,7 +163,7 @@ size: type: description: Algorithm used to generate the TLS/SSL private key returned: changed or success - type: string + type: str sample: RSA curve: description: Elliptic curve used to generate the TLS/SSL private key @@ -173,7 +173,7 @@ curve: filename: description: Path to the generated TLS/SSL private key file returned: changed or success - type: string + type: str sample: /etc/ssl/private/ansible.com.pem fingerprint: description: The fingerprint of the public key. Fingerprint will be generated for diff --git a/lib/ansible/modules/crypto/openssl_publickey.py b/lib/ansible/modules/crypto/openssl_publickey.py index 6ff923ffc9..0f7d6af044 100644 --- a/lib/ansible/modules/crypto/openssl_publickey.py +++ b/lib/ansible/modules/crypto/openssl_publickey.py @@ -97,17 +97,17 @@ RETURN = ''' privatekey: description: Path to the TLS/SSL private key the public key was generated from returned: changed or success - type: string + type: str sample: /etc/ssl/private/ansible.com.pem format: description: The format of the public key (PEM, OpenSSH, ...) returned: changed or success - type: string + type: str sample: PEM filename: description: Path to the generated TLS/SSL public key file returned: changed or success - type: string + type: str sample: /etc/ssl/public/ansible.com.pem fingerprint: description: The fingerprint of the public key. Fingerprint will be generated for each hashlib.algorithms available. diff --git a/lib/ansible/modules/database/misc/kibana_plugin.py b/lib/ansible/modules/database/misc/kibana_plugin.py index 95a5ed16a3..3db9f88bc3 100644 --- a/lib/ansible/modules/database/misc/kibana_plugin.py +++ b/lib/ansible/modules/database/misc/kibana_plugin.py @@ -84,31 +84,31 @@ RETURN = ''' cmd: description: the launched command during plugin management (install / remove) returned: success - type: string + type: str name: description: the plugin name to install or remove returned: success - type: string + type: str url: description: the url from where the plugin is installed from returned: success - type: string + type: str timeout: description: the timeout for plugin download returned: success - type: string + type: str stdout: description: the command stdout returned: success - type: string + type: str stderr: description: the command stderr returned: success - type: string + type: str state: description: the state for the managed plugin returned: success - type: string + type: str ''' import os diff --git a/lib/ansible/modules/database/mongodb/mongodb_parameter.py b/lib/ansible/modules/database/mongodb/mongodb_parameter.py index 2820982f08..870fb954cb 100644 --- a/lib/ansible/modules/database/mongodb/mongodb_parameter.py +++ b/lib/ansible/modules/database/mongodb/mongodb_parameter.py @@ -85,11 +85,11 @@ RETURN = ''' before: description: value before modification returned: success - type: string + type: str after: description: value after modification returned: success - type: string + type: str ''' import os diff --git a/lib/ansible/modules/database/mongodb/mongodb_shard.py b/lib/ansible/modules/database/mongodb/mongodb_shard.py index 0563bae860..081887e926 100644 --- a/lib/ansible/modules/database/mongodb/mongodb_shard.py +++ b/lib/ansible/modules/database/mongodb/mongodb_shard.py @@ -117,7 +117,7 @@ RETURN = ''' mongodb_shard: description: The name of the shard to create. returned: success - type: string + type: str ''' import os diff --git a/lib/ansible/modules/database/mongodb/mongodb_user.py b/lib/ansible/modules/database/mongodb/mongodb_user.py index 5d15b9714a..6e6093ff8d 100644 --- a/lib/ansible/modules/database/mongodb/mongodb_user.py +++ b/lib/ansible/modules/database/mongodb/mongodb_user.py @@ -172,7 +172,7 @@ RETURN = ''' user: description: The name of the user to add or remove. returned: success - type: string + type: str ''' import os diff --git a/lib/ansible/modules/database/postgresql/postgresql_schema.py b/lib/ansible/modules/database/postgresql/postgresql_schema.py index 339a5c4d58..914155ed8f 100644 --- a/lib/ansible/modules/database/postgresql/postgresql_schema.py +++ b/lib/ansible/modules/database/postgresql/postgresql_schema.py @@ -108,7 +108,7 @@ RETURN = ''' schema: description: Name of the schema returned: success, changed - type: string + type: str sample: "acme" ''' diff --git a/lib/ansible/modules/files/archive.py b/lib/ansible/modules/files/archive.py index 157a37fdf9..31f6769ba7 100644 --- a/lib/ansible/modules/files/archive.py +++ b/lib/ansible/modules/files/archive.py @@ -107,7 +107,7 @@ state: If 'compress', then the file source file is in the compressed state. If 'archive', then the source file or paths are currently archived. If 'incomplete', then an archive was created, but not all source paths were found. - type: string + type: str returned: always missing: description: Any files that were missing from the source. @@ -119,7 +119,7 @@ archived: returned: success arcroot: description: The archive root. - type: string + type: str returned: always expanded_paths: description: The list of matching paths from paths argument. diff --git a/lib/ansible/modules/files/copy.py b/lib/ansible/modules/files/copy.py index 782993c73e..56521348cf 100644 --- a/lib/ansible/modules/files/copy.py +++ b/lib/ansible/modules/files/copy.py @@ -191,27 +191,27 @@ RETURN = r''' dest: description: Destination file/path returned: success - type: string + type: str sample: /path/to/file.txt src: description: Source file used for the copy on the target machine returned: changed - type: string + type: str sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source md5sum: description: MD5 checksum of the file after running copy returned: when supported - type: string + type: str sample: 2a5aeecc61dc98c4d780b14b330e3282 checksum: description: SHA1 checksum of the file after running copy returned: success - type: string + type: str sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 backup_file: description: Name of backup file created returned: changed and if backup=yes - type: string + type: str sample: /path/to/file.txt.2015-02-12@22:09~ gid: description: Group id of the file, after execution @@ -221,12 +221,12 @@ gid: group: description: Group of the file, after execution returned: success - type: string + type: str sample: httpd owner: description: Owner of the file, after execution returned: success - type: string + type: str sample: httpd uid: description: Owner id of the file, after execution @@ -236,7 +236,7 @@ uid: mode: description: Permissions of the target, after execution returned: success - type: string + type: str sample: 0644 size: description: Size of the target, after execution @@ -246,7 +246,7 @@ size: state: description: State of the target, after execution returned: success - type: string + type: str sample: file ''' diff --git a/lib/ansible/modules/files/find.py b/lib/ansible/modules/files/find.py index b5183f92b9..d665b03fb7 100644 --- a/lib/ansible/modules/files/find.py +++ b/lib/ansible/modules/files/find.py @@ -191,12 +191,12 @@ files: matched: description: number of matches returned: success - type: string + type: str sample: 14 examined: description: number of filesystem objects looked at returned: success - type: string + type: str sample: 34 ''' diff --git a/lib/ansible/modules/files/stat.py b/lib/ansible/modules/files/stat.py index d0f96c3409..0b627085c0 100644 --- a/lib/ansible/modules/files/stat.py +++ b/lib/ansible/modules/files/stat.py @@ -144,12 +144,12 @@ stat: exists: description: if the destination path actually exists or not returned: success - type: boolean + type: bool sample: True path: description: The full path of the file/object to get the facts of returned: success and if path exists - type: string + type: str sample: '/path/to/file' mode: description: Unix permissions of the file in octal @@ -159,37 +159,37 @@ stat: isdir: description: Tells you if the path is a directory returned: success, path exists and user can read stats - type: boolean + type: bool sample: False ischr: description: Tells you if the path is a character device returned: success, path exists and user can read stats - type: boolean + type: bool sample: False isblk: description: Tells you if the path is a block device returned: success, path exists and user can read stats - type: boolean + type: bool sample: False isreg: description: Tells you if the path is a regular file returned: success, path exists and user can read stats - type: boolean + type: bool sample: True isfifo: description: Tells you if the path is a named pipe returned: success, path exists and user can read stats - type: boolean + type: bool sample: False islnk: description: Tells you if the path is a symbolic link returned: success, path exists and user can read stats - type: boolean + type: bool sample: False issock: description: Tells you if the path is a unix domain socket returned: success, path exists and user can read stats - type: boolean + type: bool sample: False uid: description: Numeric id representing the file owner @@ -239,67 +239,67 @@ stat: wusr: description: Tells you if the owner has write permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True rusr: description: Tells you if the owner has read permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True xusr: description: Tells you if the owner has execute permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True wgrp: description: Tells you if the owner's group has write permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: False rgrp: description: Tells you if the owner's group has read permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True xgrp: description: Tells you if the owner's group has execute permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True woth: description: Tells you if others have write permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: False roth: description: Tells you if others have read permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True xoth: description: Tells you if others have execute permission returned: success, path exists and user can read stats - type: boolean + type: bool sample: True isuid: description: Tells you if the invoking user's id matches the owner's id returned: success, path exists and user can read stats - type: boolean + type: bool sample: False isgid: description: Tells you if the invoking user's group id matches the owner's group id returned: success, path exists and user can read stats - type: boolean + type: bool sample: False lnk_source: description: Target of the symlink normalized for the remote filesystem returned: success, path exists and user can read stats and the path is a symbolic link - type: string + type: str sample: /home/foobar/21102015-1445431274-908472971 lnk_target: description: Target of the symlink. Note that relative paths remain relative returned: success, path exists and user can read stats and the path is a symbolic link - type: string + type: str sample: ../foobar/21102015-1445431274-908472971 version_added: 2.4 md5: @@ -307,54 +307,54 @@ stat: favor of the checksum return value returned: success, path exists and user can read stats and path supports hashing and md5 is supported - type: string + type: str sample: f88fa92d8cf2eeecf4c0a50ccc96d0c0 checksum: description: hash of the path returned: success, path exists, user can read stats, path supports hashing and supplied checksum algorithm is available - type: string + type: str sample: 50ba294cdf28c0d5bcde25708df53346825a429f pw_name: description: User name of owner returned: success, path exists and user can read stats and installed python supports it - type: string + type: str sample: httpd gr_name: description: Group name of owner returned: success, path exists and user can read stats and installed python supports it - type: string + type: str sample: www-data mimetype: description: file magic data or mime-type returned: success, path exists and user can read stats and installed python supports it and the `mime` option was true, will return 'unknown' on error. - type: string + type: str sample: application/pdf; charset=binary charset: description: file character set or encoding returned: success, path exists and user can read stats and installed python supports it and the `mime` option was true, will return 'unknown' on error. - type: string + type: str sample: us-ascii readable: description: Tells you if the invoking user has the right to read the path returned: success, path exists and user can read the path - type: boolean + type: bool sample: False version_added: 2.2 writeable: description: Tells you if the invoking user has the right to write the path returned: success, path exists and user can write the path - type: boolean + type: bool sample: False version_added: 2.2 executable: description: Tells you if the invoking user has the execute the path returned: success, path exists and user can execute the path - type: boolean + type: bool sample: False version_added: 2.2 attributes: diff --git a/lib/ansible/modules/files/tempfile.py b/lib/ansible/modules/files/tempfile.py index c6ade9054e..38e7745fe8 100644 --- a/lib/ansible/modules/files/tempfile.py +++ b/lib/ansible/modules/files/tempfile.py @@ -70,7 +70,7 @@ RETURN = ''' path: description: Path to created file or directory returned: success - type: string + type: str sample: "/tmp/ansible.bMlvdk" ''' diff --git a/lib/ansible/modules/files/xml.py b/lib/ansible/modules/files/xml.py index 2ebef9334e..fa8bfe9098 100644 --- a/lib/ansible/modules/files/xml.py +++ b/lib/ansible/modules/files/xml.py @@ -252,11 +252,11 @@ matches: returned: when parameter 'print_match' is set msg: description: A message related to the performed action(s). - type: string + type: str returned: always xmlstring: description: An XML string of the resulting output. - type: string + type: str returned: when parameter 'xmlstring' is set ''' diff --git a/lib/ansible/modules/identity/cyberark/cyberark_authentication.py b/lib/ansible/modules/identity/cyberark/cyberark_authentication.py index 60257fc2fd..064a0a33a3 100644 --- a/lib/ansible/modules/identity/cyberark/cyberark_authentication.py +++ b/lib/ansible/modules/identity/cyberark/cyberark_authentication.py @@ -91,11 +91,11 @@ cyberark_session: sample: api_base_url: description: Base URL for API calls. Returned in the cyberark_session, so it can be used in subsequent calls. - type: string + type: str returned: always token: description: The token that identifies the session, encoded in BASE 64. - type: string + type: str returned: always use_shared_logon_authentication: description: Whether or not Shared Logon Authentication was used to establish the session. diff --git a/lib/ansible/modules/identity/keycloak/keycloak_client.py b/lib/ansible/modules/identity/keycloak/keycloak_client.py index 9da009bfe7..7c1fe806dd 100644 --- a/lib/ansible/modules/identity/keycloak/keycloak_client.py +++ b/lib/ansible/modules/identity/keycloak/keycloak_client.py @@ -596,7 +596,7 @@ RETURN = ''' msg: description: Message as to what action was taken returned: always - type: string + type: str sample: "Client testclient has been updated" proposed: diff --git a/lib/ansible/modules/identity/keycloak/keycloak_clienttemplate.py b/lib/ansible/modules/identity/keycloak/keycloak_clienttemplate.py index 3a746a3bc4..7bd0b927cd 100644 --- a/lib/ansible/modules/identity/keycloak/keycloak_clienttemplate.py +++ b/lib/ansible/modules/identity/keycloak/keycloak_clienttemplate.py @@ -212,7 +212,7 @@ RETURN = ''' msg: description: Message as to what action was taken returned: always - type: string + type: str sample: "Client template testclient has been updated" proposed: diff --git a/lib/ansible/modules/messaging/rabbitmq/rabbitmq_global_parameter.py b/lib/ansible/modules/messaging/rabbitmq/rabbitmq_global_parameter.py index 484b1c757d..8ca660d405 100644 --- a/lib/ansible/modules/messaging/rabbitmq/rabbitmq_global_parameter.py +++ b/lib/ansible/modules/messaging/rabbitmq/rabbitmq_global_parameter.py @@ -58,12 +58,12 @@ RETURN = ''' name: description: name of the global parameter being set returned: success - type: string + type: str sample: "cluster_name" value: description: value of the global parameter, as a JSON term returned: changed - type: string + type: str sample: "the-cluster-name" ''' diff --git a/lib/ansible/modules/monitoring/circonus_annotation.py b/lib/ansible/modules/monitoring/circonus_annotation.py index 095ab7aee9..0447e853f0 100644 --- a/lib/ansible/modules/monitoring/circonus_annotation.py +++ b/lib/ansible/modules/monitoring/circonus_annotation.py @@ -88,7 +88,7 @@ annotation: _cid: description: annotation identifier returned: success - type: string + type: str sample: /annotation/100000 _created: description: creation timestamp @@ -103,22 +103,22 @@ annotation: _last_modified_by: description: last modified by returned: success - type: string + type: str sample: /user/1000 category: description: category of the created annotation returned: success - type: string + type: str sample: alerts title: description: title of the created annotation returned: success - type: string + type: str sample: WARNING description: description: description of the created annotation returned: success - type: string + type: str sample: Host is down. start: description: timestamp, since annotation applies @@ -128,7 +128,7 @@ annotation: stop: description: timestamp, since annotation ends returned: success - type: string + type: str sample: Host is down. rel_metrics: description: Array of metrics related to this annotation, each metrics is a string. diff --git a/lib/ansible/modules/monitoring/grafana_dashboard.py b/lib/ansible/modules/monitoring/grafana_dashboard.py index e04113af54..48e8548fcf 100644 --- a/lib/ansible/modules/monitoring/grafana_dashboard.py +++ b/lib/ansible/modules/monitoring/grafana_dashboard.py @@ -131,7 +131,7 @@ RETURN = ''' uid: description: uid or slug of the created / deleted / exported dashboard. returned: success - type: string + type: str sample: 000000063 ''' diff --git a/lib/ansible/modules/monitoring/grafana_datasource.py b/lib/ansible/modules/monitoring/grafana_datasource.py index 0adea724f9..a5173451d9 100644 --- a/lib/ansible/modules/monitoring/grafana_datasource.py +++ b/lib/ansible/modules/monitoring/grafana_datasource.py @@ -305,7 +305,7 @@ RETURN = ''' name: description: name of the datasource created. returned: success - type: string + type: str sample: test-ds id: description: Id of the datasource diff --git a/lib/ansible/modules/monitoring/grafana_plugin.py b/lib/ansible/modules/monitoring/grafana_plugin.py index c6be8a3c2b..d737e92fea 100644 --- a/lib/ansible/modules/monitoring/grafana_plugin.py +++ b/lib/ansible/modules/monitoring/grafana_plugin.py @@ -61,7 +61,7 @@ RETURN = ''' --- version: description: version of the installed / removed plugin. - type: string + type: str returned: allways ''' diff --git a/lib/ansible/modules/monitoring/icinga2_host.py b/lib/ansible/modules/monitoring/icinga2_host.py index c0b7701172..7033237340 100644 --- a/lib/ansible/modules/monitoring/icinga2_host.py +++ b/lib/ansible/modules/monitoring/icinga2_host.py @@ -113,7 +113,7 @@ EXAMPLES = ''' RETURN = ''' name: description: The name used to create, modify or delete the host - type: string + type: str returned: always data: description: The data structure used for create, modify or delete of the host diff --git a/lib/ansible/modules/monitoring/logicmonitor.py b/lib/ansible/modules/monitoring/logicmonitor.py index 6f5da3db3d..e4acfdb4df 100644 --- a/lib/ansible/modules/monitoring/logicmonitor.py +++ b/lib/ansible/modules/monitoring/logicmonitor.py @@ -13,7 +13,7 @@ RETURN = ''' success: description: flag indicating that execution was successful returned: success - type: boolean + type: bool sample: True ... ''' diff --git a/lib/ansible/modules/monitoring/sensu_client.py b/lib/ansible/modules/monitoring/sensu_client.py index fe1c739fd9..fb19a0b4de 100644 --- a/lib/ansible/modules/monitoring/sensu_client.py +++ b/lib/ansible/modules/monitoring/sensu_client.py @@ -139,7 +139,7 @@ config: file: description: Path to the client configuration file returned: success - type: string + type: str sample: "/etc/sensu/conf.d/client.json" ''' diff --git a/lib/ansible/modules/monitoring/sensu_handler.py b/lib/ansible/modules/monitoring/sensu_handler.py index be69e3d55e..f64acb7e8c 100644 --- a/lib/ansible/modules/monitoring/sensu_handler.py +++ b/lib/ansible/modules/monitoring/sensu_handler.py @@ -140,12 +140,12 @@ config: file: description: Path to the handler configuration file returned: success - type: string + type: str sample: "/etc/sensu/conf.d/handlers/irc.json" name: description: Name of the handler returned: success - type: string + type: str sample: "irc" ''' diff --git a/lib/ansible/modules/monitoring/zabbix/zabbix_action.py b/lib/ansible/modules/monitoring/zabbix/zabbix_action.py index 2933181bcf..d6ac8de8aa 100644 --- a/lib/ansible/modules/monitoring/zabbix/zabbix_action.py +++ b/lib/ansible/modules/monitoring/zabbix/zabbix_action.py @@ -385,7 +385,7 @@ RETURN = ''' msg: description: The result of the operation returned: success - type: string + type: str sample: 'Action Deleted: Register webservers, ID: 0001' ''' diff --git a/lib/ansible/modules/monitoring/zabbix/zabbix_template.py b/lib/ansible/modules/monitoring/zabbix/zabbix_template.py index 67a2b8b0e8..21f47039ca 100644 --- a/lib/ansible/modules/monitoring/zabbix/zabbix_template.py +++ b/lib/ansible/modules/monitoring/zabbix/zabbix_template.py @@ -166,7 +166,7 @@ RETURN = ''' template_json: description: The JSON dump of the template returned: when state is dump - type: string + type: str sample: { "zabbix_export":{ "date":"2017-11-29T16:37:24Z", diff --git a/lib/ansible/modules/net_tools/basics/get_url.py b/lib/ansible/modules/net_tools/basics/get_url.py index 2cc1c14b0d..6a3b3574d8 100644 --- a/lib/ansible/modules/net_tools/basics/get_url.py +++ b/lib/ansible/modules/net_tools/basics/get_url.py @@ -223,22 +223,22 @@ RETURN = r''' backup_file: description: name of backup file created after download returned: changed and if backup=yes - type: string + type: str sample: /path/to/file.txt.2015-02-12@22:09~ checksum_dest: description: sha1 checksum of the file after copy returned: success - type: string + type: str sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 checksum_src: description: sha1 checksum of the file returned: success - type: string + type: str sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 dest: description: destination file/path returned: success - type: string + type: str sample: /path/to/file.txt elapsed: description: The number of seconds that elapsed while performing the download @@ -253,32 +253,32 @@ gid: group: description: group of the file returned: success - type: string + type: str sample: "httpd" md5sum: description: md5 checksum of the file after download returned: when supported - type: string + type: str sample: "2a5aeecc61dc98c4d780b14b330e3282" mode: description: permissions of the target returned: success - type: string + type: str sample: "0644" msg: description: the HTTP message from the request returned: always - type: string + type: str sample: OK (unknown bytes) owner: description: owner of the file returned: success - type: string + type: str sample: httpd secontext: description: the SELinux security context of the file returned: success - type: string + type: str sample: unconfined_u:object_r:user_tmp_t:s0 size: description: size of the target @@ -288,12 +288,12 @@ size: src: description: source file used after download returned: always - type: string + type: str sample: /tmp/tmpAdFLdV state: description: state of the target returned: success - type: string + type: str sample: file status_code: description: the HTTP status code from the request @@ -308,7 +308,7 @@ uid: url: description: the actual URL used for the request returned: always - type: string + type: str sample: https://www.ansible.com/ ''' diff --git a/lib/ansible/modules/net_tools/basics/uri.py b/lib/ansible/modules/net_tools/basics/uri.py index f290af8892..8a16453d8d 100644 --- a/lib/ansible/modules/net_tools/basics/uri.py +++ b/lib/ansible/modules/net_tools/basics/uri.py @@ -245,7 +245,7 @@ elapsed: msg: description: The HTTP message from the request returned: always - type: string + type: str sample: OK (unknown bytes) redirected: description: Whether the request was redirected @@ -260,7 +260,7 @@ status: url: description: The actual URL used for the request returned: always - type: string + type: str sample: https://www.ansible.com/ ''' diff --git a/lib/ansible/modules/net_tools/cloudflare_dns.py b/lib/ansible/modules/net_tools/cloudflare_dns.py index 3d29dc4618..9e1eecd65d 100644 --- a/lib/ansible/modules/net_tools/cloudflare_dns.py +++ b/lib/ansible/modules/net_tools/cloudflare_dns.py @@ -233,17 +233,17 @@ record: content: description: the record content (details depend on record type) returned: success - type: string + type: str sample: 192.0.2.91 created_on: description: the record creation date returned: success - type: string + type: str sample: 2016-03-25T19:09:42.516553Z data: description: additional record data returned: success, if type is SRV, DS, SSHFP or TLSA - type: dictionary + type: dict sample: { name: "jabber", port: 8080, @@ -256,27 +256,27 @@ record: id: description: the record id returned: success - type: string + type: str sample: f9efb0549e96abcb750de63b38c9576e locked: description: No documentation available returned: success - type: boolean + type: bool sample: False meta: description: No documentation available returned: success - type: dictionary + type: dict sample: { auto_added: false } modified_on: description: record modification date returned: success - type: string + type: str sample: 2016-03-25T19:09:42.516553Z name: description: the record name as FQDN (including _service and _proto for SRV) returned: success - type: string + type: str sample: www.sample.com priority: description: priority of the MX record @@ -286,12 +286,12 @@ record: proxiable: description: whether this record can be proxied through cloudflare returned: success - type: boolean + type: bool sample: False proxied: description: whether the record is proxied through cloudflare returned: success - type: boolean + type: bool sample: False ttl: description: the time-to-live for the record @@ -301,17 +301,17 @@ record: type: description: the record type returned: success - type: string + type: str sample: A zone_id: description: the id of the zone containing the record returned: success - type: string + type: str sample: abcede0bf9f0066f94029d2e6b73856a zone_name: description: the name of the zone containing the record returned: success - type: string + type: str sample: sample.com ''' diff --git a/lib/ansible/modules/net_tools/exoscale/exo_dns_domain.py b/lib/ansible/modules/net_tools/exoscale/exo_dns_domain.py index 6482b3995c..3176d9e8cf 100644 --- a/lib/ansible/modules/net_tools/exoscale/exo_dns_domain.py +++ b/lib/ansible/modules/net_tools/exoscale/exo_dns_domain.py @@ -68,12 +68,12 @@ exo_dns_domain: created_at: description: When the domain was created returned: success - type: string + type: str sample: "2016-08-12T15:24:23.989Z" expires_on: description: When the domain expires returned: success - type: string + type: str sample: "2016-08-12T15:24:23.989Z" id: description: ID of the domain @@ -88,7 +88,7 @@ exo_dns_domain: name: description: Domain name returned: success - type: string + type: str sample: example.com record_count: description: Number of records related to this domain @@ -108,22 +108,22 @@ exo_dns_domain: state: description: State of the domain returned: success - type: string + type: str sample: "hosted" token: description: Token returned: success - type: string + type: str sample: "r4NzTRp6opIeFKfaFYvOd6MlhGyD07jl" unicode_name: description: Domain name as unicode returned: success - type: string + type: str sample: "example.com" updated_at: description: When the domain was updated last. returned: success - type: string + type: str sample: "2016-08-12T15:24:23.989Z" user_id: description: ID of the user diff --git a/lib/ansible/modules/net_tools/exoscale/exo_dns_record.py b/lib/ansible/modules/net_tools/exoscale/exo_dns_record.py index 88d8dd510f..ccd8b741ee 100644 --- a/lib/ansible/modules/net_tools/exoscale/exo_dns_record.py +++ b/lib/ansible/modules/net_tools/exoscale/exo_dns_record.py @@ -131,17 +131,17 @@ exo_dns_record: content: description: value of the record returned: success - type: string + type: str sample: 1.2.3.4 created_at: description: When the record was created returned: success - type: string + type: str sample: "2016-08-12T15:24:23.989Z" domain: description: Name of the domain returned: success - type: string + type: str sample: example.com domain_id: description: ID of the domain @@ -156,7 +156,7 @@ exo_dns_record: name: description: name of the record returned: success - type: string + type: str sample: www parent_id: description: ID of the parent @@ -171,7 +171,7 @@ exo_dns_record: record_type: description: Priority of the record returned: success - type: string + type: str sample: A system_record: description: Whether the record is a system record or not @@ -186,7 +186,7 @@ exo_dns_record: updated_at: description: When the record was updated returned: success - type: string + type: str sample: "2016-08-12T15:24:23.989Z" ''' diff --git a/lib/ansible/modules/net_tools/infinity/infinity.py b/lib/ansible/modules/net_tools/infinity/infinity.py index 920f3a6c1c..842831863a 100644 --- a/lib/ansible/modules/net_tools/infinity/infinity.py +++ b/lib/ansible/modules/net_tools/infinity/infinity.py @@ -124,17 +124,17 @@ RETURN = """ network_id: description: id for a given network returned: success - type: string + type: str sample: '1501' ip_info: description: when reserve next available ip address from a network, the ip address info ) is returned. returned: success - type: string + type: str sample: '{"address": "192.168.10.3", "hostname": "", "FQDN": "", "domainname": "", "id": 3229}' network_info: description: when reserving a LAN network from a Infinity supernet by providing network_size, the information about the reserved network is returned. returned: success - type: string + type: str sample: {"network_address": "192.168.10.32/28","network_family": "4", "network_id": 3102, "network_size": null,"description": null,"network_location": "3085", "ranges": { "id": 0, "name": null,"first_ip": null,"type": null,"last_ip": null}, diff --git a/lib/ansible/modules/net_tools/ipify_facts.py b/lib/ansible/modules/net_tools/ipify_facts.py index 7109f40ee1..0c3d5b8c55 100644 --- a/lib/ansible/modules/net_tools/ipify_facts.py +++ b/lib/ansible/modules/net_tools/ipify_facts.py @@ -62,7 +62,7 @@ RETURN = ''' ipify_public_ip: description: Public IP of the internet gateway. returned: success - type: string + type: str sample: 1.2.3.4 ''' diff --git a/lib/ansible/modules/net_tools/ipinfoio_facts.py b/lib/ansible/modules/net_tools/ipinfoio_facts.py index f1e9efae1d..3c708cf836 100644 --- a/lib/ansible/modules/net_tools/ipinfoio_facts.py +++ b/lib/ansible/modules/net_tools/ipinfoio_facts.py @@ -49,35 +49,35 @@ ansible_facts: contains: ip: description: "Public IP address of a host" - type: string + type: str sample: "8.8.8.8" hostname: description: Domain name - type: string + type: str sample: "google-public-dns-a.google.com" country: description: ISO 3166-1 alpha-2 country code - type: string + type: str sample: "US" region: description: State or province name - type: string + type: str sample: "California" city: description: City name - type: string + type: str sample: "Mountain View" loc: description: Latitude and Longitude of the location - type: string + type: str sample: "37.3860,-122.0838" org: description: "organization's name" - type: string + type: str sample: "AS3356 Level 3 Communications, Inc." postal: description: Postal code - type: string + type: str sample: "94035" ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/net_tools/netcup_dns.py b/lib/ansible/modules/net_tools/netcup_dns.py index 8604887d5c..5c7b48065e 100644 --- a/lib/ansible/modules/net_tools/netcup_dns.py +++ b/lib/ansible/modules/net_tools/netcup_dns.py @@ -137,17 +137,17 @@ records: name: description: the record name returned: success - type: string + type: str sample: fancy-hostname type: description: the record type returned: succcess - type: string + type: str sample: A value: description: the record destination returned: success - type: string + type: str sample: 127.0.0.1 priority: description: the record priority (only relevant if type=MX) diff --git a/lib/ansible/modules/net_tools/nsupdate.py b/lib/ansible/modules/net_tools/nsupdate.py index 6da94c6c6e..265c518a2c 100644 --- a/lib/ansible/modules/net_tools/nsupdate.py +++ b/lib/ansible/modules/net_tools/nsupdate.py @@ -118,11 +118,11 @@ RETURN = ''' changed: description: If module has modified record returned: success - type: string + type: str record: description: DNS record returned: success - type: string + type: str sample: 'ansible' ttl: description: DNS record TTL @@ -132,7 +132,7 @@ ttl: type: description: DNS record type returned: success - type: string + type: str sample: 'CNAME' value: description: DNS record value(s) @@ -142,7 +142,7 @@ value: zone: description: DNS record zone returned: success - type: string + type: str sample: 'example.org.' dns_rc: description: dnspython return code @@ -152,7 +152,7 @@ dns_rc: dns_rc_str: description: dnspython return code (string representation) returned: always - type: string + type: str sample: 'REFUSED' ''' diff --git a/lib/ansible/modules/net_tools/omapi_host.py b/lib/ansible/modules/net_tools/omapi_host.py index 316cf356dd..32eb2a8c16 100644 --- a/lib/ansible/modules/net_tools/omapi_host.py +++ b/lib/ansible/modules/net_tools/omapi_host.py @@ -98,7 +98,7 @@ RETURN = ''' changed: description: If module has modified a host returned: success - type: string + type: str lease: description: dictionary containing host information returned: success @@ -107,12 +107,12 @@ lease: ip-address: description: IP address, if there is. returned: success - type: string + type: str sample: '192.168.1.5' hardware-address: description: MAC address returned: success - type: string + type: str sample: '00:11:22:33:44:55' hardware-type: description: hardware type, generally '1' @@ -122,7 +122,7 @@ lease: name: description: hostname returned: success - type: string + type: str sample: 'mydesktop' ''' diff --git a/lib/ansible/modules/net_tools/snmp_facts.py b/lib/ansible/modules/net_tools/snmp_facts.py index 4267a5cb7f..7de197dd03 100644 --- a/lib/ansible/modules/net_tools/snmp_facts.py +++ b/lib/ansible/modules/net_tools/snmp_facts.py @@ -91,12 +91,12 @@ RETURN = ''' ansible_sysdescr: description: A textual description of the entity. returned: success - type: string + type: str sample: Linux ubuntu-user 4.4.0-93-generic #116-Ubuntu SMP Fri Aug 11 21:17:51 UTC 2017 x86_64 ansible_sysobjectid: description: The vendor's authoritative identification of the network management subsystem contained in the entity. returned: success - type: string + type: str sample: 1.3.6.1.4.1.8072.3.2.10 ansible_sysuptime: description: The time (in hundredths of a second) since the network management portion of the system was last re-initialized. @@ -106,17 +106,17 @@ ansible_sysuptime: ansible_syscontact: description: The textual identification of the contact person for this managed node, together with information on how to contact this person. returned: success - type: string + type: str sample: Me <me@example.org> ansible_sysname: description: An administratively-assigned name for this managed node. returned: success - type: string + type: str sample: ubuntu-user ansible_syslocation: description: The physical location of this node (e.g., `telephone closet, 3rd floor'). returned: success - type: string + type: str sample: Sitting on the Dock of the Bay ansible_all_ipv4_addresses: description: List of all IPv4 addresses. diff --git a/lib/ansible/modules/network/a10/a10_server.py b/lib/ansible/modules/network/a10/a10_server.py index 8173fd6aa8..5a98722ee4 100644 --- a/lib/ansible/modules/network/a10/a10_server.py +++ b/lib/ansible/modules/network/a10/a10_server.py @@ -93,7 +93,7 @@ RETURN = ''' content: description: the full info regarding the slb_server returned: success - type: string + type: str sample: "mynewserver" ''' import json diff --git a/lib/ansible/modules/network/a10/a10_service_group.py b/lib/ansible/modules/network/a10/a10_service_group.py index 168423bffe..20d4daba74 100644 --- a/lib/ansible/modules/network/a10/a10_service_group.py +++ b/lib/ansible/modules/network/a10/a10_service_group.py @@ -109,7 +109,7 @@ RETURN = ''' content: description: the full info regarding the slb_service_group returned: success - type: string + type: str sample: "mynewservicegroup" ''' import json diff --git a/lib/ansible/modules/network/a10/a10_virtual_server.py b/lib/ansible/modules/network/a10/a10_virtual_server.py index d7b2c009cf..aec5035b90 100644 --- a/lib/ansible/modules/network/a10/a10_virtual_server.py +++ b/lib/ansible/modules/network/a10/a10_virtual_server.py @@ -95,7 +95,7 @@ RETURN = ''' content: description: the full info regarding the slb_virtual returned: success - type: string + type: str sample: "mynewvirtualserver" ''' import json diff --git a/lib/ansible/modules/network/aci/aci_aaa_user.py b/lib/ansible/modules/network/aci/aci_aaa_user.py index 0fe7f7d402..21160cf5cf 100644 --- a/lib/ansible/modules/network/aci/aci_aaa_user.py +++ b/lib/ansible/modules/network/aci/aci_aaa_user.py @@ -176,7 +176,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -225,17 +225,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: '?rsp-prop-include=config-only' method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -245,7 +245,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_aaa_user_certificate.py b/lib/ansible/modules/network/aci/aci_aaa_user_certificate.py index ddc18490df..2ce6b906f5 100644 --- a/lib/ansible/modules/network/aci/aci_aaa_user_certificate.py +++ b/lib/ansible/modules/network/aci/aci_aaa_user_certificate.py @@ -136,7 +136,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -185,17 +185,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -205,7 +205,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_access_port_block_to_access_port.py b/lib/ansible/modules/network/aci/aci_access_port_block_to_access_port.py index b214ccff28..4e3808419e 100644 --- a/lib/ansible/modules/network/aci/aci_access_port_block_to_access_port.py +++ b/lib/ansible/modules/network/aci/aci_access_port_block_to_access_port.py @@ -182,7 +182,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -231,17 +231,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -251,7 +251,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_access_port_to_interface_policy_leaf_profile.py b/lib/ansible/modules/network/aci/aci_access_port_to_interface_policy_leaf_profile.py index f4c806742b..088b4864a4 100644 --- a/lib/ansible/modules/network/aci/aci_access_port_to_interface_policy_leaf_profile.py +++ b/lib/ansible/modules/network/aci/aci_access_port_to_interface_policy_leaf_profile.py @@ -203,7 +203,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -252,17 +252,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -272,7 +272,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_aep.py b/lib/ansible/modules/network/aci/aci_aep.py index f9bb3ed284..c3ddede046 100644 --- a/lib/ansible/modules/network/aci/aci_aep.py +++ b/lib/ansible/modules/network/aci/aci_aep.py @@ -126,7 +126,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -175,17 +175,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -195,7 +195,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_aep_to_domain.py b/lib/ansible/modules/network/aci/aci_aep_to_domain.py index b38305c096..65a4f612d5 100644 --- a/lib/ansible/modules/network/aci/aci_aep_to_domain.py +++ b/lib/ansible/modules/network/aci/aci_aep_to_domain.py @@ -140,7 +140,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -189,17 +189,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -209,7 +209,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_ap.py b/lib/ansible/modules/network/aci/aci_ap.py index b8c43c189e..6ac50732d3 100644 --- a/lib/ansible/modules/network/aci/aci_ap.py +++ b/lib/ansible/modules/network/aci/aci_ap.py @@ -131,7 +131,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -180,17 +180,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -200,7 +200,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_bd.py b/lib/ansible/modules/network/aci/aci_bd.py index 095cf15e03..d9336ea96c 100644 --- a/lib/ansible/modules/network/aci/aci_bd.py +++ b/lib/ansible/modules/network/aci/aci_bd.py @@ -253,7 +253,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -302,17 +302,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -322,7 +322,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_bd_subnet.py b/lib/ansible/modules/network/aci/aci_bd_subnet.py index 00b67e9c99..3e09211cea 100644 --- a/lib/ansible/modules/network/aci/aci_bd_subnet.py +++ b/lib/ansible/modules/network/aci/aci_bd_subnet.py @@ -260,7 +260,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -309,17 +309,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -329,7 +329,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_bd_to_l3out.py b/lib/ansible/modules/network/aci/aci_bd_to_l3out.py index 3c2dde1958..f2a83d3a1b 100644 --- a/lib/ansible/modules/network/aci/aci_bd_to_l3out.py +++ b/lib/ansible/modules/network/aci/aci_bd_to_l3out.py @@ -87,7 +87,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -136,17 +136,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -156,7 +156,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_config_rollback.py b/lib/ansible/modules/network/aci/aci_config_rollback.py index 60171f1588..847aa8706a 100644 --- a/lib/ansible/modules/network/aci/aci_config_rollback.py +++ b/lib/ansible/modules/network/aci/aci_config_rollback.py @@ -144,7 +144,7 @@ RETURN = r''' preview: description: A preview between two snapshots returned: when state is preview - type: string + type: str error: description: The error information as returned from the APIC returned: failure @@ -157,22 +157,22 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -182,7 +182,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_config_snapshot.py b/lib/ansible/modules/network/aci/aci_config_snapshot.py index 868fa7dc2b..b21950366f 100644 --- a/lib/ansible/modules/network/aci/aci_config_snapshot.py +++ b/lib/ansible/modules/network/aci/aci_config_snapshot.py @@ -146,7 +146,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -195,17 +195,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -215,7 +215,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_contract.py b/lib/ansible/modules/network/aci/aci_contract.py index c647c4b3b3..721547b25f 100644 --- a/lib/ansible/modules/network/aci/aci_contract.py +++ b/lib/ansible/modules/network/aci/aci_contract.py @@ -153,7 +153,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -202,17 +202,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -222,7 +222,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_contract_subject.py b/lib/ansible/modules/network/aci/aci_contract_subject.py index 89066f15ec..bed455a34e 100644 --- a/lib/ansible/modules/network/aci/aci_contract_subject.py +++ b/lib/ansible/modules/network/aci/aci_contract_subject.py @@ -172,7 +172,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -221,17 +221,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -241,7 +241,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py b/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py index a6e0a492a7..21274597ff 100644 --- a/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py +++ b/lib/ansible/modules/network/aci/aci_contract_subject_to_filter.py @@ -154,7 +154,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -203,17 +203,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -223,7 +223,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_domain.py b/lib/ansible/modules/network/aci/aci_domain.py index 64b93ef8b6..ed0148eff4 100644 --- a/lib/ansible/modules/network/aci/aci_domain.py +++ b/lib/ansible/modules/network/aci/aci_domain.py @@ -175,7 +175,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -224,17 +224,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -244,7 +244,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_domain_to_encap_pool.py b/lib/ansible/modules/network/aci/aci_domain_to_encap_pool.py index ca6be752f9..49ac49f5b1 100644 --- a/lib/ansible/modules/network/aci/aci_domain_to_encap_pool.py +++ b/lib/ansible/modules/network/aci/aci_domain_to_encap_pool.py @@ -160,7 +160,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -209,17 +209,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -229,7 +229,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_domain_to_vlan_pool.py b/lib/ansible/modules/network/aci/aci_domain_to_vlan_pool.py index e584c6010f..11655a5845 100644 --- a/lib/ansible/modules/network/aci/aci_domain_to_vlan_pool.py +++ b/lib/ansible/modules/network/aci/aci_domain_to_vlan_pool.py @@ -176,7 +176,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -225,17 +225,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -245,7 +245,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_encap_pool.py b/lib/ansible/modules/network/aci/aci_encap_pool.py index cfcc8cf19b..966091b91b 100644 --- a/lib/ansible/modules/network/aci/aci_encap_pool.py +++ b/lib/ansible/modules/network/aci/aci_encap_pool.py @@ -136,7 +136,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -185,17 +185,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -205,7 +205,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_encap_pool_range.py b/lib/ansible/modules/network/aci/aci_encap_pool_range.py index 917643b8eb..e097dffebf 100644 --- a/lib/ansible/modules/network/aci/aci_encap_pool_range.py +++ b/lib/ansible/modules/network/aci/aci_encap_pool_range.py @@ -175,7 +175,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -224,17 +224,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -244,7 +244,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_epg.py b/lib/ansible/modules/network/aci/aci_epg.py index 21042e2896..2cfc567523 100644 --- a/lib/ansible/modules/network/aci/aci_epg.py +++ b/lib/ansible/modules/network/aci/aci_epg.py @@ -213,7 +213,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -262,17 +262,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -282,7 +282,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_epg_monitoring_policy.py b/lib/ansible/modules/network/aci/aci_epg_monitoring_policy.py index 9dba3fab79..245d7815dd 100644 --- a/lib/ansible/modules/network/aci/aci_epg_monitoring_policy.py +++ b/lib/ansible/modules/network/aci/aci_epg_monitoring_policy.py @@ -99,7 +99,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -148,17 +148,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -168,7 +168,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_epg_to_contract.py b/lib/ansible/modules/network/aci/aci_epg_to_contract.py index ad2c1101f9..5b8d36e983 100644 --- a/lib/ansible/modules/network/aci/aci_epg_to_contract.py +++ b/lib/ansible/modules/network/aci/aci_epg_to_contract.py @@ -163,7 +163,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -212,17 +212,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -232,7 +232,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_epg_to_domain.py b/lib/ansible/modules/network/aci/aci_epg_to_domain.py index bec868172b..5d6e725f3b 100644 --- a/lib/ansible/modules/network/aci/aci_epg_to_domain.py +++ b/lib/ansible/modules/network/aci/aci_epg_to_domain.py @@ -200,7 +200,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -249,17 +249,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -269,7 +269,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_fabric_node.py b/lib/ansible/modules/network/aci/aci_fabric_node.py index 091b8d2abd..38fed3836a 100644 --- a/lib/ansible/modules/network/aci/aci_fabric_node.py +++ b/lib/ansible/modules/network/aci/aci_fabric_node.py @@ -128,7 +128,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -177,17 +177,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: '?rsp-prop-include=config-only' method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -197,7 +197,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_filter.py b/lib/ansible/modules/network/aci/aci_filter.py index 44b7dd14e7..18ca2a9033 100644 --- a/lib/ansible/modules/network/aci/aci_filter.py +++ b/lib/ansible/modules/network/aci/aci_filter.py @@ -132,7 +132,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -181,17 +181,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -201,7 +201,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_filter_entry.py b/lib/ansible/modules/network/aci/aci_filter_entry.py index b2032f9dc4..264cb7c2cb 100644 --- a/lib/ansible/modules/network/aci/aci_filter_entry.py +++ b/lib/ansible/modules/network/aci/aci_filter_entry.py @@ -157,7 +157,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -206,17 +206,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -226,7 +226,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_firmware_source.py b/lib/ansible/modules/network/aci/aci_firmware_source.py index 849461240f..ccaf85294a 100644 --- a/lib/ansible/modules/network/aci/aci_firmware_source.py +++ b/lib/ansible/modules/network/aci/aci_firmware_source.py @@ -137,7 +137,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -186,17 +186,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -206,7 +206,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_fc.py b/lib/ansible/modules/network/aci/aci_interface_policy_fc.py index a368a170af..36a5b57e2b 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_fc.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_fc.py @@ -95,7 +95,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -144,17 +144,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -164,7 +164,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_l2.py b/lib/ansible/modules/network/aci/aci_interface_policy_l2.py index a988df8b6d..a7ef6c33f8 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_l2.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_l2.py @@ -105,7 +105,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -154,17 +154,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -174,7 +174,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_leaf_policy_group.py b/lib/ansible/modules/network/aci/aci_interface_policy_leaf_policy_group.py index fe671b3abd..a8a33ed2ca 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_leaf_policy_group.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_leaf_policy_group.py @@ -240,7 +240,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -289,17 +289,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -309,7 +309,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_leaf_profile.py b/lib/ansible/modules/network/aci/aci_interface_policy_leaf_profile.py index 74582b4110..dd61f034f0 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_leaf_profile.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_leaf_profile.py @@ -117,7 +117,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -166,17 +166,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -186,7 +186,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_lldp.py b/lib/ansible/modules/network/aci/aci_interface_policy_lldp.py index 0a45048bbc..107c4bf5b3 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_lldp.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_lldp.py @@ -100,7 +100,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -149,17 +149,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -169,7 +169,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_mcp.py b/lib/ansible/modules/network/aci/aci_interface_policy_mcp.py index e0aa28a7ce..b41d40a6b3 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_mcp.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_mcp.py @@ -94,7 +94,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -143,17 +143,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -163,7 +163,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_ospf.py b/lib/ansible/modules/network/aci/aci_interface_policy_ospf.py index 2ee969b470..c207c80a95 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_ospf.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_ospf.py @@ -212,7 +212,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -261,17 +261,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -281,7 +281,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_port_channel.py b/lib/ansible/modules/network/aci/aci_interface_policy_port_channel.py index b3b2e74b41..eecd25e2da 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_port_channel.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_port_channel.py @@ -144,7 +144,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -193,17 +193,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -213,7 +213,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_policy_port_security.py b/lib/ansible/modules/network/aci/aci_interface_policy_port_security.py index cc4f249dd6..0e2f297e44 100644 --- a/lib/ansible/modules/network/aci/aci_interface_policy_port_security.py +++ b/lib/ansible/modules/network/aci/aci_interface_policy_port_security.py @@ -95,7 +95,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -144,17 +144,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -164,7 +164,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_interface_selector_to_switch_policy_leaf_profile.py b/lib/ansible/modules/network/aci/aci_interface_selector_to_switch_policy_leaf_profile.py index 127a5b5021..a212bffccf 100644 --- a/lib/ansible/modules/network/aci/aci_interface_selector_to_switch_policy_leaf_profile.py +++ b/lib/ansible/modules/network/aci/aci_interface_selector_to_switch_policy_leaf_profile.py @@ -113,7 +113,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -162,17 +162,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -182,7 +182,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_l3out.py b/lib/ansible/modules/network/aci/aci_l3out.py index aa986a6842..0e28670688 100644 --- a/lib/ansible/modules/network/aci/aci_l3out.py +++ b/lib/ansible/modules/network/aci/aci_l3out.py @@ -163,7 +163,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -212,17 +212,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -232,7 +232,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py b/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py index 096503c4f6..88c7039136 100644 --- a/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py +++ b/lib/ansible/modules/network/aci/aci_l3out_route_tag_policy.py @@ -106,7 +106,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -155,17 +155,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -175,7 +175,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_rest.py b/lib/ansible/modules/network/aci/aci_rest.py index ecc3e9175d..fd38c6a3a4 100644 --- a/lib/ansible/modules/network/aci/aci_rest.py +++ b/lib/ansible/modules/network/aci/aci_rest.py @@ -200,27 +200,27 @@ error_code: error_text: description: The REST ACI descriptive text, useful for troubleshooting on failure returned: always - type: string + type: str sample: unknown managed object class foo imdata: description: Converted output returned by the APIC REST (register this for post-processing) returned: always - type: string + type: str sample: [{"error": {"attributes": {"code": "122", "text": "unknown managed object class foo"}}}] payload: description: The (templated) payload send to the APIC REST API (xml or json) returned: always - type: string + type: str sample: '<foo bar="boo"/>' raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' response: description: HTTP response string returned: always - type: string + type: str sample: 'HTTP Error 400: Bad Request' status: description: HTTP status code @@ -230,12 +230,12 @@ status: totalCount: description: Number of items in the imdata array returned: always - type: string + type: str sample: '0' url: description: URL used for APIC REST call returned: success - type: string + type: str sample: https://1.2.3.4/api/mo/uni/tn-[Dag].json?rsp-subtree=modified ''' diff --git a/lib/ansible/modules/network/aci/aci_static_binding_to_epg.py b/lib/ansible/modules/network/aci/aci_static_binding_to_epg.py index edce94fc55..4d2d50362c 100644 --- a/lib/ansible/modules/network/aci/aci_static_binding_to_epg.py +++ b/lib/ansible/modules/network/aci/aci_static_binding_to_epg.py @@ -206,7 +206,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -255,17 +255,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -275,7 +275,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_switch_leaf_selector.py b/lib/ansible/modules/network/aci/aci_switch_leaf_selector.py index 696b2f5624..6fbf18eaa2 100644 --- a/lib/ansible/modules/network/aci/aci_switch_leaf_selector.py +++ b/lib/ansible/modules/network/aci/aci_switch_leaf_selector.py @@ -160,7 +160,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -209,17 +209,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -229,7 +229,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_switch_policy_leaf_profile.py b/lib/ansible/modules/network/aci/aci_switch_policy_leaf_profile.py index 04381f1d73..fd2454fcfe 100644 --- a/lib/ansible/modules/network/aci/aci_switch_policy_leaf_profile.py +++ b/lib/ansible/modules/network/aci/aci_switch_policy_leaf_profile.py @@ -109,7 +109,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -158,17 +158,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -178,7 +178,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_switch_policy_vpc_protection_group.py b/lib/ansible/modules/network/aci/aci_switch_policy_vpc_protection_group.py index ba4358b6bb..36780d1699 100644 --- a/lib/ansible/modules/network/aci/aci_switch_policy_vpc_protection_group.py +++ b/lib/ansible/modules/network/aci/aci_switch_policy_vpc_protection_group.py @@ -137,7 +137,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -186,17 +186,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -206,7 +206,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_taboo_contract.py b/lib/ansible/modules/network/aci/aci_taboo_contract.py index 6a18fb6a8d..f73ce5d7db 100644 --- a/lib/ansible/modules/network/aci/aci_taboo_contract.py +++ b/lib/ansible/modules/network/aci/aci_taboo_contract.py @@ -136,7 +136,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -185,17 +185,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -205,7 +205,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_tenant.py b/lib/ansible/modules/network/aci/aci_tenant.py index 1257b9cbd8..3f2b481d88 100644 --- a/lib/ansible/modules/network/aci/aci_tenant.py +++ b/lib/ansible/modules/network/aci/aci_tenant.py @@ -117,7 +117,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -166,17 +166,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -186,7 +186,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_tenant_action_rule_profile.py b/lib/ansible/modules/network/aci/aci_tenant_action_rule_profile.py index 0d7bd495f4..bddb3da24d 100644 --- a/lib/ansible/modules/network/aci/aci_tenant_action_rule_profile.py +++ b/lib/ansible/modules/network/aci/aci_tenant_action_rule_profile.py @@ -97,7 +97,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -146,17 +146,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -166,7 +166,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_tenant_ep_retention_policy.py b/lib/ansible/modules/network/aci/aci_tenant_ep_retention_policy.py index f50b31c2d1..11ba6c60e5 100644 --- a/lib/ansible/modules/network/aci/aci_tenant_ep_retention_policy.py +++ b/lib/ansible/modules/network/aci/aci_tenant_ep_retention_policy.py @@ -169,7 +169,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -218,17 +218,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -238,7 +238,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_tenant_span_dst_group.py b/lib/ansible/modules/network/aci/aci_tenant_span_dst_group.py index 79b71a1321..7fefc27ccb 100644 --- a/lib/ansible/modules/network/aci/aci_tenant_span_dst_group.py +++ b/lib/ansible/modules/network/aci/aci_tenant_span_dst_group.py @@ -99,7 +99,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -148,17 +148,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -168,7 +168,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_tenant_span_src_group.py b/lib/ansible/modules/network/aci/aci_tenant_span_src_group.py index f6678d91ce..c58eddedc7 100644 --- a/lib/ansible/modules/network/aci/aci_tenant_span_src_group.py +++ b/lib/ansible/modules/network/aci/aci_tenant_span_src_group.py @@ -107,7 +107,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -156,17 +156,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -176,7 +176,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_tenant_span_src_group_to_dst_group.py b/lib/ansible/modules/network/aci/aci_tenant_span_src_group_to_dst_group.py index b59c1dfc11..59e981aff8 100644 --- a/lib/ansible/modules/network/aci/aci_tenant_span_src_group_to_dst_group.py +++ b/lib/ansible/modules/network/aci/aci_tenant_span_src_group_to_dst_group.py @@ -102,7 +102,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -151,17 +151,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -171,7 +171,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_vlan_pool.py b/lib/ansible/modules/network/aci/aci_vlan_pool.py index 906f918b41..f6ab9718b3 100644 --- a/lib/ansible/modules/network/aci/aci_vlan_pool.py +++ b/lib/ansible/modules/network/aci/aci_vlan_pool.py @@ -128,7 +128,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -177,17 +177,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -197,7 +197,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_vlan_pool_encap_block.py b/lib/ansible/modules/network/aci/aci_vlan_pool_encap_block.py index 58e002edd6..7df5386188 100644 --- a/lib/ansible/modules/network/aci/aci_vlan_pool_encap_block.py +++ b/lib/ansible/modules/network/aci/aci_vlan_pool_encap_block.py @@ -164,7 +164,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -213,17 +213,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -233,7 +233,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aci/aci_vrf.py b/lib/ansible/modules/network/aci/aci_vrf.py index 45e592df04..15e036dd03 100644 --- a/lib/ansible/modules/network/aci/aci_vrf.py +++ b/lib/ansible/modules/network/aci/aci_vrf.py @@ -141,7 +141,7 @@ error: raw: description: The raw output returned by the APIC REST API (xml or json) returned: parse error - type: string + type: str sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>' sent: description: The actual/minimal configuration pushed to the APIC @@ -190,17 +190,17 @@ proposed: filter_string: description: The filter string used for the request returned: failure or debug - type: string + type: str sample: ?rsp-prop-include=config-only method: description: The HTTP method used for the request to the APIC returned: failure or debug - type: string + type: str sample: POST response: description: The HTTP response from the APIC returned: failure or debug - type: string + type: str sample: OK (30 bytes) status: description: The HTTP status from the APIC @@ -210,7 +210,7 @@ status: url: description: The HTTP url used for the request to the APIC returned: failure or debug - type: string + type: str sample: https://10.11.12.13/api/mo/uni/tn-production.json ''' diff --git a/lib/ansible/modules/network/aireos/aireos_config.py b/lib/ansible/modules/network/aireos/aireos_config.py index 5736727b09..e1ec2cf685 100644 --- a/lib/ansible/modules/network/aireos/aireos_config.py +++ b/lib/ansible/modules/network/aireos/aireos_config.py @@ -166,7 +166,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/aireos_config.2016-07-16@22:28:34 """ from ansible.module_utils.network.aireos.aireos import run_commands, get_config, load_config diff --git a/lib/ansible/modules/network/aruba/aruba_config.py b/lib/ansible/modules/network/aruba/aruba_config.py index d9e8902641..dd2cba6645 100644 --- a/lib/ansible/modules/network/aruba/aruba_config.py +++ b/lib/ansible/modules/network/aruba/aruba_config.py @@ -195,7 +195,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/aruba_config.2016-07-16@22:28:34 """ diff --git a/lib/ansible/modules/network/asa/asa_config.py b/lib/ansible/modules/network/asa/asa_config.py index 5c4e18bf72..40c70c0ead 100644 --- a/lib/ansible/modules/network/asa/asa_config.py +++ b/lib/ansible/modules/network/asa/asa_config.py @@ -218,7 +218,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/asa_config.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/cli/cli_command.py b/lib/ansible/modules/network/cli/cli_command.py index 8c53bbd91d..d89ece1b19 100644 --- a/lib/ansible/modules/network/cli/cli_command.py +++ b/lib/ansible/modules/network/cli/cli_command.py @@ -99,7 +99,7 @@ RETURN = """ stdout: description: The response from the command returned: when sendonly is false - type: string + type: str sample: 'Version: VyOS 1.1.7[...]' json: diff --git a/lib/ansible/modules/network/cloudengine/ce_aaa_server.py b/lib/ansible/modules/network/cloudengine/ce_aaa_server.py index 636e1c4e6b..d70a3a8be7 100644 --- a/lib/ansible/modules/network/cloudengine/ce_aaa_server.py +++ b/lib/ansible/modules/network/cloudengine/ce_aaa_server.py @@ -141,7 +141,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py b/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py index e0d5995e04..60a02589c1 100644 --- a/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py +++ b/lib/ansible/modules/network/cloudengine/ce_aaa_server_host.py @@ -199,7 +199,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_acl.py b/lib/ansible/modules/network/cloudengine/ce_acl.py index 2e4a3b8924..3ab45960e6 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl.py @@ -160,7 +160,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_acl_advance.py b/lib/ansible/modules/network/cloudengine/ce_acl_advance.py index 36cfae33e0..32a4d284ee 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl_advance.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl_advance.py @@ -261,7 +261,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_acl_interface.py b/lib/ansible/modules/network/cloudengine/ce_acl_interface.py index acc58f784e..c903633960 100644 --- a/lib/ansible/modules/network/cloudengine/ce_acl_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_acl_interface.py @@ -92,7 +92,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_global.py b/lib/ansible/modules/network/cloudengine/ce_bfd_global.py index b61760b7d4..c1416013d8 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_global.py @@ -170,7 +170,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_session.py b/lib/ansible/modules/network/cloudengine/ce_bfd_session.py index 4076f6bf89..7c743ff38e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_session.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_session.py @@ -158,7 +158,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bfd_view.py b/lib/ansible/modules/network/cloudengine/ce_bfd_view.py index 31085eb82b..d8b90c2835 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bfd_view.py +++ b/lib/ansible/modules/network/cloudengine/ce_bfd_view.py @@ -181,7 +181,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp.py b/lib/ansible/modules/network/cloudengine/ce_bgp.py index 8a6816e8ec..0396ed4e3b 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp.py @@ -187,7 +187,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp_af.py b/lib/ansible/modules/network/cloudengine/ce_bgp_af.py index dae0a6575c..20bbd5b17f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_af.py @@ -397,7 +397,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py index 3d325b73e7..23f5f2b8c0 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor.py @@ -222,7 +222,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py index aa2518d142..e828a2c8be 100644 --- a/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_bgp_neighbor_af.py @@ -353,7 +353,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_config.py b/lib/ansible/modules/network/cloudengine/ce_config.py index 3ff877e1c8..75739f2244 100644 --- a/lib/ansible/modules/network/cloudengine/ce_config.py +++ b/lib/ansible/modules/network/cloudengine/ce_config.py @@ -185,7 +185,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/ce_config.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/cloudengine/ce_dldp.py b/lib/ansible/modules/network/cloudengine/ce_dldp.py index cdfd483f3d..6785374ec6 100644 --- a/lib/ansible/modules/network/cloudengine/ce_dldp.py +++ b/lib/ansible/modules/network/cloudengine/ce_dldp.py @@ -157,7 +157,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py b/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py index 04ed8d4216..83d93ae50a 100644 --- a/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_dldp_interface.py @@ -161,7 +161,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py b/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py index 44d8906bd2..2029112727 100644 --- a/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py +++ b/lib/ansible/modules/network/cloudengine/ce_eth_trunk.py @@ -129,7 +129,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py b/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py index 8cf0491ef6..21f23b02bb 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_bd_vni.py @@ -244,7 +244,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py index 032b32ef74..51c139afad 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp.py @@ -125,7 +125,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true end_state: description: k/v pairs of configuration after module execution diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py index 526db927ed..afd5bc0d38 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_bgp_rr.py @@ -163,7 +163,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_evpn_global.py b/lib/ansible/modules/network/cloudengine/ce_evpn_global.py index 75bad9abb1..f0d811c221 100644 --- a/lib/ansible/modules/network/cloudengine/ce_evpn_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_evpn_global.py @@ -96,7 +96,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_file_copy.py b/lib/ansible/modules/network/cloudengine/ce_file_copy.py index 199c9b4d8a..6e8ef64b4c 100644 --- a/lib/ansible/modules/network/cloudengine/ce_file_copy.py +++ b/lib/ansible/modules/network/cloudengine/ce_file_copy.py @@ -87,22 +87,22 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true transfer_result: description: information about transfer result. returned: always - type: string + type: str sample: 'The local file has been successfully transferred to the device.' local_file: description: The path of the local file. returned: always - type: string + type: str sample: '/usr/work/vrpcfg.zip' remote_file: description: The path of the remote file. returned: always - type: string + type: str sample: '/vrpcfg.zip' ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py b/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py index fdae33452b..06512c92b4 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_debug.py @@ -113,7 +113,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_global.py b/lib/ansible/modules/network/cloudengine/ce_info_center_global.py index e2f7b10954..01f0819a6b 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_global.py @@ -280,7 +280,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_log.py b/lib/ansible/modules/network/cloudengine/ce_info_center_log.py index ce900c06a8..c3c70d2850 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_log.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_log.py @@ -135,7 +135,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py b/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py index 356c55aa90..7a5b542602 100644 --- a/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py +++ b/lib/ansible/modules/network/cloudengine/ce_info_center_trap.py @@ -124,7 +124,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_interface.py b/lib/ansible/modules/network/cloudengine/ce_interface.py index 43ba50645a..e3bbbfc5ce 100644 --- a/lib/ansible/modules/network/cloudengine/ce_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_interface.py @@ -143,7 +143,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py b/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py index a390077fc4..37fc13c65a 100644 --- a/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py +++ b/lib/ansible/modules/network/cloudengine/ce_interface_ospf.py @@ -162,7 +162,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ip_interface.py b/lib/ansible/modules/network/cloudengine/ce_ip_interface.py index 106a57eb4e..ccf7d49306 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ip_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_ip_interface.py @@ -141,7 +141,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_mlag_config.py b/lib/ansible/modules/network/cloudengine/ce_mlag_config.py index b85ac7010b..3335976d7e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mlag_config.py +++ b/lib/ansible/modules/network/cloudengine/ce_mlag_config.py @@ -118,7 +118,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py b/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py index 142b3cd785..b17e04e601 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_mlag_interface.py @@ -107,7 +107,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_mtu.py b/lib/ansible/modules/network/cloudengine/ce_mtu.py index 3f89a7962b..d1e802b51d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_mtu.py +++ b/lib/ansible/modules/network/cloudengine/ce_mtu.py @@ -128,7 +128,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netconf.py b/lib/ansible/modules/network/cloudengine/ce_netconf.py index 95043c5494..5359b5cad6 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netconf.py +++ b/lib/ansible/modules/network/cloudengine/ce_netconf.py @@ -109,7 +109,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true end_state: description: k/v pairs of aaa params after module execution diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py b/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py index 2c2578995e..2765a553cb 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_aging.py @@ -187,7 +187,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_export.py b/lib/ansible/modules/network/cloudengine/ce_netstream_export.py index 961092d71a..c22b8c6793 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_export.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_export.py @@ -184,7 +184,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_global.py b/lib/ansible/modules/network/cloudengine/ce_netstream_global.py index 7d3b07f75d..f8ad7e5749 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_global.py @@ -208,7 +208,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_netstream_template.py b/lib/ansible/modules/network/cloudengine/ce_netstream_template.py index 293dca80ee..c592811549 100644 --- a/lib/ansible/modules/network/cloudengine/ce_netstream_template.py +++ b/lib/ansible/modules/network/cloudengine/ce_netstream_template.py @@ -109,7 +109,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_ntp.py b/lib/ansible/modules/network/cloudengine/ce_ntp.py index 5fb5264402..ab0dfceeac 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ntp.py +++ b/lib/ansible/modules/network/cloudengine/ce_ntp.py @@ -125,7 +125,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py b/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py index 8a810a3ea2..969450f12f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py +++ b/lib/ansible/modules/network/cloudengine/ce_ntp_auth.py @@ -173,7 +173,7 @@ end_state: state: description: state as sent in from the playbook returned: always - type: string + type: str sample: "present" updates: description: command sent to the device @@ -187,7 +187,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ospf.py b/lib/ansible/modules/network/cloudengine/ce_ospf.py index 4365fb0f81..8840b1b16d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ospf.py +++ b/lib/ansible/modules/network/cloudengine/ce_ospf.py @@ -132,7 +132,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py b/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py index b262ce0248..ff084668f4 100644 --- a/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py +++ b/lib/ansible/modules/network/cloudengine/ce_ospf_vrf.py @@ -249,7 +249,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: False ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_reboot.py b/lib/ansible/modules/network/cloudengine/ce_reboot.py index e29f181038..e8b8cb0f83 100644 --- a/lib/ansible/modules/network/cloudengine/ce_reboot.py +++ b/lib/ansible/modules/network/cloudengine/ce_reboot.py @@ -68,7 +68,7 @@ RETURN = ''' rebooted: description: Whether the device was instructed to reboot. returned: success - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_rollback.py b/lib/ansible/modules/network/cloudengine/ce_rollback.py index 168fc92528..fd6a2335c0 100644 --- a/lib/ansible/modules/network/cloudengine/ce_rollback.py +++ b/lib/ansible/modules/network/cloudengine/ce_rollback.py @@ -104,7 +104,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true end_state: description: k/v pairs of configuration after module execution diff --git a/lib/ansible/modules/network/cloudengine/ce_sflow.py b/lib/ansible/modules/network/cloudengine/ce_sflow.py index 90403b8d26..963342be00 100644 --- a/lib/ansible/modules/network/cloudengine/ce_sflow.py +++ b/lib/ansible/modules/network/cloudengine/ce_sflow.py @@ -198,7 +198,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_community.py b/lib/ansible/modules/network/cloudengine/ce_snmp_community.py index 05cc7b0735..23c1d5158c 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_community.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_community.py @@ -117,7 +117,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py b/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py index 5f0acaf683..47f8f66ac6 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_contact.py @@ -74,7 +74,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_location.py b/lib/ansible/modules/network/cloudengine/ce_snmp_location.py index 29e8701dea..03199b2d0d 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_location.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_location.py @@ -74,7 +74,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py b/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py index c99daced55..ddb0084d47 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_target_host.py @@ -115,7 +115,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py b/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py index 85625a4aa2..8deb48967b 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_traps.py @@ -98,7 +98,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_snmp_user.py b/lib/ansible/modules/network/cloudengine/ce_snmp_user.py index ec640d59dd..bbf08b4d80 100644 --- a/lib/ansible/modules/network/cloudengine/ce_snmp_user.py +++ b/lib/ansible/modules/network/cloudengine/ce_snmp_user.py @@ -120,7 +120,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_startup.py b/lib/ansible/modules/network/cloudengine/ce_startup.py index 9bafde486c..819ec8faec 100644 --- a/lib/ansible/modules/network/cloudengine/ce_startup.py +++ b/lib/ansible/modules/network/cloudengine/ce_startup.py @@ -96,7 +96,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_static_route.py b/lib/ansible/modules/network/cloudengine/ce_static_route.py index a76b36301c..636aa665e5 100644 --- a/lib/ansible/modules/network/cloudengine/ce_static_route.py +++ b/lib/ansible/modules/network/cloudengine/ce_static_route.py @@ -158,7 +158,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_stp.py b/lib/ansible/modules/network/cloudengine/ce_stp.py index fe3e8d7bdc..c299cbacf7 100644 --- a/lib/ansible/modules/network/cloudengine/ce_stp.py +++ b/lib/ansible/modules/network/cloudengine/ce_stp.py @@ -140,7 +140,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_switchport.py b/lib/ansible/modules/network/cloudengine/ce_switchport.py index 341e81d025..0ad1989451 100644 --- a/lib/ansible/modules/network/cloudengine/ce_switchport.py +++ b/lib/ansible/modules/network/cloudengine/ce_switchport.py @@ -141,7 +141,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vlan.py b/lib/ansible/modules/network/cloudengine/ce_vlan.py index cf7c7761c7..2fed160c9b 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vlan.py +++ b/lib/ansible/modules/network/cloudengine/ce_vlan.py @@ -125,7 +125,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf.py b/lib/ansible/modules/network/cloudengine/ce_vrf.py index ecc77e9ade..b6f6a90b8e 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf.py @@ -102,7 +102,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf_af.py b/lib/ansible/modules/network/cloudengine/ce_vrf_af.py index aa82ed252f..f6de1e6f63 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf_af.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf_af.py @@ -176,7 +176,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py b/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py index 032263f75f..bed004c0d9 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrf_interface.py @@ -115,7 +115,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vrrp.py b/lib/ansible/modules/network/cloudengine/ce_vrrp.py index 639a74db9d..928902465b 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vrrp.py +++ b/lib/ansible/modules/network/cloudengine/ce_vrrp.py @@ -209,7 +209,7 @@ RETURN = ''' changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true proposed: description: k/v pairs of parameters passed into module diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py index d01adf340a..a30caa90e6 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_arp.py @@ -144,7 +144,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py index 6b346a0d6d..9540e80fb3 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_gateway.py @@ -170,7 +170,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py index a1ae959312..21f956b8bc 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_global.py @@ -118,7 +118,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py index fbba7b9def..b24a51ea5f 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_tunnel.py @@ -107,7 +107,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true end_state: description: k/v pairs of configuration after module execution diff --git a/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py b/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py index 0c3aca0afd..96f856c378 100644 --- a/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py +++ b/lib/ansible/modules/network/cloudengine/ce_vxlan_vap.py @@ -125,7 +125,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/cloudvision/cv_server_provision.py b/lib/ansible/modules/network/cloudvision/cv_server_provision.py index aebc73c993..925ebba35f 100644 --- a/lib/ansible/modules/network/cloudvision/cv_server_provision.py +++ b/lib/ansible/modules/network/cloudvision/cv_server_provision.py @@ -182,14 +182,14 @@ changed: currentConfigBlock: description: The current config block for the user specified interface returned: when action = show - type: string + type: str sample: | interface Ethernet4 ! newConfigBlock: description: The new config block for the user specified interface returned: when action = add or remove - type: string + type: str sample: | interface Ethernet3 description example @@ -199,14 +199,14 @@ oldConfigBlock: description: The current config block for the user specified interface before any changes are made returned: when action = add or remove - type: string + type: str sample: | interface Ethernet3 ! fullConfig: description: The full config of the configlet after being updated returned: when action = add or remove - type: string + type: str sample: | ! interface Ethernet3 @@ -216,7 +216,7 @@ fullConfig: updateConfigletResponse: description: Response returned from CVP when configlet update is triggered returned: when action = add or remove and configuration changes - type: string + type: str sample: "Configlet veos1-server successfully updated and task initiated." portConfigurable: description: Signifies if the user specified port has an entry in the @@ -233,7 +233,7 @@ switchConfigurable: switchInfo: description: Information from CVP describing the switch being configured returned: success - type: dictionary + type: dict sample: {"architecture": "i386", "bootupTimeStamp": 1491264298.21, "complianceCode": "0000", @@ -283,7 +283,7 @@ taskId: description: The task ID created by CVP because of changes to configlet returned: when action = add or remove, and auto_run = true or false, and configuration changes - type: string + type: str sample: "500" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_backup.py b/lib/ansible/modules/network/cnos/cnos_backup.py index 6c28dcf1d0..7a78cf52c2 100644 --- a/lib/ansible/modules/network/cnos/cnos_backup.py +++ b/lib/ansible/modules/network/cnos/cnos_backup.py @@ -150,7 +150,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Config file tranferred to server" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_bgp.py b/lib/ansible/modules/network/cnos/cnos_bgp.py index 5c18453e3d..366a018c56 100644 --- a/lib/ansible/modules/network/cnos/cnos_bgp.py +++ b/lib/ansible/modules/network/cnos/cnos_bgp.py @@ -310,7 +310,7 @@ msg: description: Success or failure message. Upon any failure, the method returns an error display string. returned: always - type: string + type: str ''' import sys diff --git a/lib/ansible/modules/network/cnos/cnos_conditional_command.py b/lib/ansible/modules/network/cnos/cnos_conditional_command.py index 3412ddd510..32f616902d 100644 --- a/lib/ansible/modules/network/cnos/cnos_conditional_command.py +++ b/lib/ansible/modules/network/cnos/cnos_conditional_command.py @@ -94,7 +94,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Command Applied" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_conditional_template.py b/lib/ansible/modules/network/cnos/cnos_conditional_template.py index c6645706f8..6e583cf61e 100644 --- a/lib/ansible/modules/network/cnos/cnos_conditional_template.py +++ b/lib/ansible/modules/network/cnos/cnos_conditional_template.py @@ -108,7 +108,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Template Applied." ''' diff --git a/lib/ansible/modules/network/cnos/cnos_config.py b/lib/ansible/modules/network/cnos/cnos_config.py index a6467aa192..a50f810a1a 100644 --- a/lib/ansible/modules/network/cnos/cnos_config.py +++ b/lib/ansible/modules/network/cnos/cnos_config.py @@ -196,7 +196,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/cnos01.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/cnos/cnos_factory.py b/lib/ansible/modules/network/cnos/cnos_factory.py index b22a47b841..fb41300b78 100644 --- a/lib/ansible/modules/network/cnos/cnos_factory.py +++ b/lib/ansible/modules/network/cnos/cnos_factory.py @@ -61,7 +61,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Switch Startup Config is Reset to factory settings" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_facts.py b/lib/ansible/modules/network/cnos/cnos_facts.py index 46fdfc28da..aa2eba449c 100644 --- a/lib/ansible/modules/network/cnos/cnos_facts.py +++ b/lib/ansible/modules/network/cnos/cnos_facts.py @@ -168,11 +168,11 @@ RETURN = ''' ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str ansible_net_image: description: Indicates the active image for the device returned: always - type: string + type: str # hardware ansible_net_memfree_mb: description: The available free memory on the remote device in MB diff --git a/lib/ansible/modules/network/cnos/cnos_image.py b/lib/ansible/modules/network/cnos/cnos_image.py index 30f1caeda6..5862a73eb3 100644 --- a/lib/ansible/modules/network/cnos/cnos_image.py +++ b/lib/ansible/modules/network/cnos/cnos_image.py @@ -115,7 +115,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Image file tranferred to device" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_interface.py b/lib/ansible/modules/network/cnos/cnos_interface.py index cee0831535..58e2e591f2 100644 --- a/lib/ansible/modules/network/cnos/cnos_interface.py +++ b/lib/ansible/modules/network/cnos/cnos_interface.py @@ -366,7 +366,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Interface configurations accomplished." ''' diff --git a/lib/ansible/modules/network/cnos/cnos_reload.py b/lib/ansible/modules/network/cnos/cnos_reload.py index cbce25a04a..f2a8723055 100644 --- a/lib/ansible/modules/network/cnos/cnos_reload.py +++ b/lib/ansible/modules/network/cnos/cnos_reload.py @@ -58,7 +58,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Device is Reloading. Please wait..." ''' diff --git a/lib/ansible/modules/network/cnos/cnos_rollback.py b/lib/ansible/modules/network/cnos/cnos_rollback.py index f0a45615e7..88f868d553 100644 --- a/lib/ansible/modules/network/cnos/cnos_rollback.py +++ b/lib/ansible/modules/network/cnos/cnos_rollback.py @@ -151,7 +151,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Config file tranferred to Device" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_save.py b/lib/ansible/modules/network/cnos/cnos_save.py index 299921ed24..1387fd9d8f 100644 --- a/lib/ansible/modules/network/cnos/cnos_save.py +++ b/lib/ansible/modules/network/cnos/cnos_save.py @@ -61,7 +61,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Switch Running Config is Saved to Startup Config" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_showrun.py b/lib/ansible/modules/network/cnos/cnos_showrun.py index ac7e099dec..927302b261 100644 --- a/lib/ansible/modules/network/cnos/cnos_showrun.py +++ b/lib/ansible/modules/network/cnos/cnos_showrun.py @@ -61,7 +61,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Running Configuration saved in file" ''' diff --git a/lib/ansible/modules/network/cnos/cnos_template.py b/lib/ansible/modules/network/cnos/cnos_template.py index c632f53ea2..5764588eae 100644 --- a/lib/ansible/modules/network/cnos/cnos_template.py +++ b/lib/ansible/modules/network/cnos/cnos_template.py @@ -80,7 +80,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Template Applied." ''' diff --git a/lib/ansible/modules/network/cnos/cnos_vlag.py b/lib/ansible/modules/network/cnos/cnos_vlag.py index e039586b4c..233e13549e 100644 --- a/lib/ansible/modules/network/cnos/cnos_vlag.py +++ b/lib/ansible/modules/network/cnos/cnos_vlag.py @@ -209,7 +209,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "vLAG configurations accomplished" ''' diff --git a/lib/ansible/modules/network/cumulus/nclu.py b/lib/ansible/modules/network/cumulus/nclu.py index cab6ef05ca..13a6e0e568 100644 --- a/lib/ansible/modules/network/cumulus/nclu.py +++ b/lib/ansible/modules/network/cumulus/nclu.py @@ -151,7 +151,7 @@ changed: msg: description: human-readable report of success or failure returned: always - type: string + type: str sample: "interface bond0 config updated" ''' diff --git a/lib/ansible/modules/network/dellos10/dellos10_config.py b/lib/ansible/modules/network/dellos10/dellos10_config.py index f4d2ad2424..ec0f01c834 100644 --- a/lib/ansible/modules/network/dellos10/dellos10_config.py +++ b/lib/ansible/modules/network/dellos10/dellos10_config.py @@ -167,7 +167,7 @@ saved: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/dellos10_config.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/dellos6/dellos6_config.py b/lib/ansible/modules/network/dellos6/dellos6_config.py index 9bd764a0a8..d7503e9540 100644 --- a/lib/ansible/modules/network/dellos6/dellos6_config.py +++ b/lib/ansible/modules/network/dellos6/dellos6_config.py @@ -169,7 +169,7 @@ saved: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/dellos6_config.2017-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/dellos6/dellos6_facts.py b/lib/ansible/modules/network/dellos6/dellos6_facts.py index 2f9f01b7b6..84d03d4401 100644 --- a/lib/ansible/modules/network/dellos6/dellos6_facts.py +++ b/lib/ansible/modules/network/dellos6/dellos6_facts.py @@ -76,11 +76,11 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device. returned: always. - type: string + type: str ansible_net_image: description: The image file that the device is running. returned: always - type: string + type: str # hardware ansible_net_memfree_mb: diff --git a/lib/ansible/modules/network/dellos9/dellos9_config.py b/lib/ansible/modules/network/dellos9/dellos9_config.py index 63cf00797d..c63a651cdc 100644 --- a/lib/ansible/modules/network/dellos9/dellos9_config.py +++ b/lib/ansible/modules/network/dellos9/dellos9_config.py @@ -174,7 +174,7 @@ saved: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/dellos9_config.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/dellos9/dellos9_facts.py b/lib/ansible/modules/network/dellos9/dellos9_facts.py index 3c17a1b5e0..b7abedf552 100644 --- a/lib/ansible/modules/network/dellos9/dellos9_facts.py +++ b/lib/ansible/modules/network/dellos9/dellos9_facts.py @@ -82,11 +82,11 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str ansible_net_image: description: The image file the device is running returned: always - type: string + type: str # hardware ansible_net_filesystems: diff --git a/lib/ansible/modules/network/edgeos/edgeos_config.py b/lib/ansible/modules/network/edgeos/edgeos_config.py index 629870d308..8a48415481 100644 --- a/lib/ansible/modules/network/edgeos/edgeos_config.py +++ b/lib/ansible/modules/network/edgeos/edgeos_config.py @@ -115,7 +115,7 @@ filtered: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/edgeos_config.2016-07-16@22:28:34 """ diff --git a/lib/ansible/modules/network/edgeswitch/edgeswitch_facts.py b/lib/ansible/modules/network/edgeswitch/edgeswitch_facts.py index 305cba6823..aea615f3cd 100644 --- a/lib/ansible/modules/network/edgeswitch/edgeswitch_facts.py +++ b/lib/ansible/modules/network/edgeswitch/edgeswitch_facts.py @@ -61,25 +61,25 @@ ansible_net_gather_subset: ansible_net_model: description: The model name returned from the device returned: always - type: string + type: str ansible_net_serialnum: description: The serial number of the remote device returned: always - type: string + type: str ansible_net_version: description: The operating system version running on the remote device returned: always - type: string + type: str ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str # config ansible_net_config: description: The current active config from the device returned: when config is configured - type: string + type: str # interfaces ansible_net_interfaces: diff --git a/lib/ansible/modules/network/enos/enos_config.py b/lib/ansible/modules/network/enos/enos_config.py index 8dac5b8d37..caaf60c8cd 100644 --- a/lib/ansible/modules/network/enos/enos_config.py +++ b/lib/ansible/modules/network/enos/enos_config.py @@ -155,7 +155,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/enos01.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/enos/enos_facts.py b/lib/ansible/modules/network/enos/enos_facts.py index 314b24f94d..7199acc3b1 100644 --- a/lib/ansible/modules/network/enos/enos_facts.py +++ b/lib/ansible/modules/network/enos/enos_facts.py @@ -109,11 +109,11 @@ RETURN = ''' ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str ansible_net_image: description: Indicates the active image for the device returned: always - type: string + type: str # hardware ansible_net_memfree_mb: description: The available free memory on the remote device in MB diff --git a/lib/ansible/modules/network/eos/eos_config.py b/lib/ansible/modules/network/eos/eos_config.py index 064a41952e..23ce45392d 100644 --- a/lib/ansible/modules/network/eos/eos_config.py +++ b/lib/ansible/modules/network/eos/eos_config.py @@ -261,7 +261,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/eos_config.2016-07-16@22:28:34 """ from ansible.module_utils._text import to_text diff --git a/lib/ansible/modules/network/exos/exos_config.py b/lib/ansible/modules/network/exos/exos_config.py index c1e8aa616f..cfbebc397a 100644 --- a/lib/ansible/modules/network/exos/exos_config.py +++ b/lib/ansible/modules/network/exos/exos_config.py @@ -185,7 +185,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/x870_config.2018-08-08@15:00:21 """ diff --git a/lib/ansible/modules/network/exos/exos_facts.py b/lib/ansible/modules/network/exos/exos_facts.py index 67941b5c40..9ddda79aa5 100644 --- a/lib/ansible/modules/network/exos/exos_facts.py +++ b/lib/ansible/modules/network/exos/exos_facts.py @@ -89,7 +89,7 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str # hardware ansible_net_memfree_mb: diff --git a/lib/ansible/modules/network/f5/_bigip_asm_policy.py b/lib/ansible/modules/network/f5/_bigip_asm_policy.py index 55f19cb166..743d1712e7 100644 --- a/lib/ansible/modules/network/f5/_bigip_asm_policy.py +++ b/lib/ansible/modules/network/f5/_bigip_asm_policy.py @@ -210,22 +210,22 @@ active: state: description: Action performed on the target device. returned: changed - type: string + type: str sample: absent file: description: Local path to ASM policy file. returned: changed - type: string + type: str sample: /root/some_policy.xml template: description: Name of the built-in ASM policy template returned: changed - type: string + type: str sample: OWA Exchange 2007 (https) name: description: Name of the ASM policy to be managed/created returned: changed - type: string + type: str sample: Asm_APP1_Transparent ''' diff --git a/lib/ansible/modules/network/f5/bigip_appsvcs_extension.py b/lib/ansible/modules/network/f5/bigip_appsvcs_extension.py index 3b99756487..2f2c1b1d39 100644 --- a/lib/ansible/modules/network/f5/bigip_appsvcs_extension.py +++ b/lib/ansible/modules/network/f5/bigip_appsvcs_extension.py @@ -103,7 +103,7 @@ action: description: - The action performed. returned: changed - type: string + type: str sample: deploy ''' diff --git a/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py b/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py index b78b82ae7d..3e2b6565ca 100644 --- a/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py +++ b/lib/ansible/modules/network/f5/bigip_asm_policy_fetch.py @@ -131,19 +131,19 @@ RETURN = r''' name: description: Name of the ASM policy to be exported. returned: changed - type: string + type: str sample: Asm_APP1_Transparent dst: description: Local path to download exported ASM policy. returned: changed - type: string + type: str sample: /root/downloads/foobar.xml file: description: - Name of the policy file on the remote BIG-IP to download. If not specified, then this will be a randomly generated filename. returned: changed - type: string + type: str sample: foobar.xml inline: description: Set when ASM policy to be exported inline diff --git a/lib/ansible/modules/network/f5/bigip_asm_policy_import.py b/lib/ansible/modules/network/f5/bigip_asm_policy_import.py index 7fd078fb4e..d0ba8a81fd 100644 --- a/lib/ansible/modules/network/f5/bigip_asm_policy_import.py +++ b/lib/ansible/modules/network/f5/bigip_asm_policy_import.py @@ -87,17 +87,17 @@ RETURN = r''' file: description: Local path to ASM policy file. returned: changed - type: string + type: str sample: /root/some_policy.xml inline: description: Contents of policy as an inline string returned: changed - type: string + type: str sample: <xml>foobar contents</xml> name: description: Name of the ASM policy to be created/overwritten returned: changed - type: string + type: str sample: Asm_APP1_Transparent force: description: Set when overwriting an existing policy diff --git a/lib/ansible/modules/network/f5/bigip_cli_alias.py b/lib/ansible/modules/network/f5/bigip_cli_alias.py index e66819dab3..2f3de80965 100644 --- a/lib/ansible/modules/network/f5/bigip_cli_alias.py +++ b/lib/ansible/modules/network/f5/bigip_cli_alias.py @@ -73,12 +73,12 @@ RETURN = r''' command: description: The new command that is aliased. returned: changed - type: string + type: str sample: run /util bash description: description: The new description of the alias. returned: changed - type: string + type: str sample: Run the bash shell ''' diff --git a/lib/ansible/modules/network/f5/bigip_cli_script.py b/lib/ansible/modules/network/f5/bigip_cli_script.py index e436d24dcf..f850000580 100644 --- a/lib/ansible/modules/network/f5/bigip_cli_script.py +++ b/lib/ansible/modules/network/f5/bigip_cli_script.py @@ -83,7 +83,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_data_group.py b/lib/ansible/modules/network/f5/bigip_data_group.py index 33d1121ccd..773bb2cc60 100644 --- a/lib/ansible/modules/network/f5/bigip_data_group.py +++ b/lib/ansible/modules/network/f5/bigip_data_group.py @@ -167,7 +167,7 @@ EXAMPLES = r''' value: "" - key: cactus value: "" - type: string + type: str provider: password: secret server: lb.mydomain.com diff --git a/lib/ansible/modules/network/f5/bigip_device_auth.py b/lib/ansible/modules/network/f5/bigip_device_auth.py index 18da90a787..ecb7092645 100644 --- a/lib/ansible/modules/network/f5/bigip_device_auth.py +++ b/lib/ansible/modules/network/f5/bigip_device_auth.py @@ -188,17 +188,17 @@ servers: authentication: description: Process the system uses to serve authentication requests when using TACACS. returned: changed - type: string + type: str sample: use-all-servers service_name: description: Name of the service the user is requesting to be authorized to use. returned: changed - type: string + type: str sample: ppp protocol_name: description: Name of the protocol associated with C(service_name) used for client authentication. returned: changed - type: string + type: str sample: ip ''' diff --git a/lib/ansible/modules/network/f5/bigip_device_auth_ldap.py b/lib/ansible/modules/network/f5/bigip_device_auth_ldap.py index e66f66cb2a..1a60dc729c 100644 --- a/lib/ansible/modules/network/f5/bigip_device_auth_ldap.py +++ b/lib/ansible/modules/network/f5/bigip_device_auth_ldap.py @@ -149,7 +149,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_device_connectivity.py b/lib/ansible/modules/network/f5/bigip_device_connectivity.py index 699d63f8a9..061af73357 100644 --- a/lib/ansible/modules/network/f5/bigip_device_connectivity.py +++ b/lib/ansible/modules/network/f5/bigip_device_connectivity.py @@ -110,17 +110,17 @@ changed: config_sync_ip: description: The new value of the C(config_sync_ip) setting. returned: changed - type: string + type: str sample: 10.1.1.1 mirror_primary_address: description: The new value of the C(mirror_primary_address) setting. returned: changed - type: string + type: str sample: 10.1.1.2 mirror_secondary_address: description: The new value of the C(mirror_secondary_address) setting. returned: changed - type: string + type: str sample: 10.1.1.3 unicast_failover: description: The new value of the C(unicast_failover) setting. @@ -134,22 +134,22 @@ failover_multicast: multicast_interface: description: The new value of the C(multicast_interface) setting. returned: changed - type: string + type: str sample: eth0 multicast_address: description: The new value of the C(multicast_address) setting. returned: changed - type: string + type: str sample: 224.0.0.245 multicast_port: description: The new value of the C(multicast_port) setting. returned: changed - type: string + type: str sample: 1026 cluster_mirroring: description: The current cluster-mirroring setting. returned: changed - type: string + type: str sample: between-clusters ''' diff --git a/lib/ansible/modules/network/f5/bigip_device_dns.py b/lib/ansible/modules/network/f5/bigip_device_dns.py index 1de22c3f90..eb2adb1ef8 100644 --- a/lib/ansible/modules/network/f5/bigip_device_dns.py +++ b/lib/ansible/modules/network/f5/bigip_device_dns.py @@ -78,7 +78,7 @@ RETURN = r''' cache: description: The new value of the DNS caching returned: changed - type: string + type: str sample: enabled name_servers: description: List of name servers that were set diff --git a/lib/ansible/modules/network/f5/bigip_device_facts.py b/lib/ansible/modules/network/f5/bigip_device_facts.py index 3c1b390f8b..56dadcb979 100644 --- a/lib/ansible/modules/network/f5/bigip_device_facts.py +++ b/lib/ansible/modules/network/f5/bigip_device_facts.py @@ -233,13 +233,13 @@ client_ssl_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/bigip02.internal name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: bigip02.internal alert_timeout: description: @@ -264,13 +264,13 @@ client_ssl_profiles: description: - Specifies how often the system authenticates a user. returned: changed - type: string + type: str sample: once ca_file: description: - Specifies the certificate authority (CA) file name. returned: changed - type: string + type: str sample: /Common/default-ca.crt cache_size: description: @@ -290,38 +290,38 @@ client_ssl_profiles: management system for the purpose of terminating or initiating an SSL connection. returned: changed - type: string + type: str sample: /Common/default.crt chain_file: description: - Specifies or builds a certificate chain file that a client can use to authenticate the profile. returned: changed - type: string + type: str sample: /Common/ca-chain.crt ciphers: description: - Specifies a list of cipher names. returned: changed - type: string + type: str sample: ['DEFAULT'] crl_file: description: - Specifies the certificate revocation list file name. returned: changed - type: string + type: str sample: /Common/default.crl parent: description: - Parent of the profile returned: changed - type: string + type: str sample: /Common/clientssl description: description: - Description of the profile. returned: changed - type: string + type: str sample: My profile modssl_methods: description: @@ -333,7 +333,7 @@ client_ssl_profiles: description: - Specifies the peer certificate mode. returned: changed - type: string + type: str sample: ignore sni_require: description: @@ -392,7 +392,7 @@ client_ssl_profiles: indication) extension information in ClientHello from a client connection. returned: changed - type: string + type: str sample: bigip01 session_ticket: description: @@ -418,7 +418,7 @@ client_ssl_profiles: description: - Specifies the secure renegotiation mode. returned: changed - type: string + type: str sample: require handshake_timeout: description: @@ -459,21 +459,21 @@ client_ssl_profiles: certification authority key when SSL forward proxy feature is enabled. returned: changed - type: string + type: str forward_proxy_ca_certificate_file: description: - Specifies the name of the certificate file that is used as the certification authority certificate when SSL forward proxy feature is enabled. returned: changed - type: string + type: str forward_proxy_ca_key_file: description: - Specifies the name of the key file that is used as the certification authority key when SSL forward proxy feature is enabled. returned: changed - type: string + type: str sample: hash/dictionary of values devices: description: Device related facts. @@ -484,13 +484,13 @@ devices: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/bigip02.internal name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: bigip02.internal active_modules: description: @@ -502,91 +502,91 @@ devices: description: - Media Access Control address (MAC address) of the device. returned: changed - type: string + type: str sample: "fa:16:3e:c3:42:6f" build: description: - The minor version information of the total product version. returned: changed - type: string + type: str sample: 0.0.1 chassis_id: description: - Serial number of the device. returned: changed - type: string + type: str sample: 11111111-2222-3333-444444444444 chassis_type: description: - Displays the chassis type. The possible values are C(individual) and C(viprion). returned: changed - type: string + type: str sample: individual comment: description: - User comments about the device. returned: changed - type: string + type: str sample: My device configsync_address: description: - IP address used for configuration synchronization. returned: changed - type: string + type: str sample: 10.10.10.10 contact: description: - Administrator contact information. returned: changed - type: string + type: str sample: The User description: description: - Description of the device. returned: changed - type: string + type: str sample: My device edition: description: - Displays the software edition. returned: changed - type: string + type: str sample: Point Release 7 failover_state: description: - Device failover state. returned: changed - type: string + type: str sample: active hostname: description: - Device hostname returned: changed - type: string + type: str sample: bigip02.internal location: description: - Specifies the physical location of the device. returned: changed - type: string + type: str sample: London management_address: description: - IP address of the management interface. returned: changed - type: string + type: str sample: 3.3.3.3 marketing_name: description: - Marketing name of the device platform. returned: changed - type: string + type: str sample: BIG-IP Virtual Edition multicast_address: description: - Specifies the multicast IP address used for failover. returned: changed - type: string + type: str sample: 4.4.4.4 optional_modules: description: @@ -598,25 +598,25 @@ devices: description: - Displays the device platform identifier. returned: changed - type: string + type: str sample: Z100 primary_mirror_address: description: - Specifies the IP address used for state mirroring. returned: changed - type: string + type: str sample: 5.5.5.5 product: description: - Displays the software product name. returned: changed - type: string + type: str sample: BIG-IP secondary_mirror_address: description: - Secondary IP address used for state mirroring. returned: changed - type: string + type: str sample: 2.2.2.2 self: description: @@ -628,7 +628,7 @@ devices: description: - Displays the software version number. returned: changed - type: string + type: str sample: 13.1.0.7 timelimited_modules: description: @@ -640,7 +640,7 @@ devices: description: - Displays the time zone configured on the device. returned: changed - type: string + type: str sample: UTC unicast_addresses: description: @@ -652,7 +652,7 @@ devices: description: - The IP address that peers can use to reach this unicast address IP. returned: changed - type: string + type: str sample: 5.4.3.5 effective_port: description: @@ -664,7 +664,7 @@ devices: description: - The IP address that the failover daemon will listen on for packets from its peers. returned: changed - type: string + type: str sample: 5.4.3.5 port: description: @@ -682,13 +682,13 @@ device_groups: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/fasthttp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: fasthttp autosync_enabled: description: @@ -700,7 +700,7 @@ device_groups: description: - Description of the device group. returned: changed - type: string + type: str sample: My device group devices: description: @@ -731,7 +731,7 @@ device_groups: description: - Specifies the type of device group. returned: changed - type: string + type: str sample: sync-only asm_sync_enabled: description: @@ -749,41 +749,41 @@ external_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/external name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: external parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: external description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" args: description: - Specifies any command-line arguments that the script requires. - type: string + type: str sample: arg1 arg2 arg3 external_program: description: - Specifies the name of the file for the monitor to use. - type: string + type: str sample: /Common/arg_example variables: description: @@ -831,13 +831,13 @@ fasthttp_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/fasthttp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: fasthttp client_close_timeout: description: @@ -890,13 +890,13 @@ fasthttp_profiles: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: fasthttp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile force_http_1_0_response: description: @@ -910,7 +910,7 @@ fasthttp_profiles: - A string that the system inserts as a header in an HTTP request. If the header exists already, the system does not replace it. returned: changed - type: string + type: str sample: "X-F5-Authentication: foo" http_1_1_close_workarounds: description: @@ -991,7 +991,7 @@ fasthttp_profiles: - How the system handles closing connections. Values provided may be C(enabled), C(disabled), or C(fast). returned: changed - type: string + type: str sample: enabled sample: hash/dictionary of values fastl4_profiles: @@ -1003,13 +1003,13 @@ fastl4_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/fastl4 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: fastl4 client_timeout: description: @@ -1026,13 +1026,13 @@ fastl4_profiles: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: fastl4 description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile explicit_flow_migration: description: @@ -1069,7 +1069,7 @@ fastl4_profiles: - When C(set), sets the outgoing packet's IP Header DF bit. - When C(clear), clears the outgoing packet's IP Header DF bit. returned: changed - type: string + type: str sample: pmtu ip_tos_to_client: description: @@ -1077,7 +1077,7 @@ fastl4_profiles: - This option specifies the ToS level that the traffic management system assigns to IP packets when sending them to clients. returned: changed - type: string or int + type: str or int sample: 200 ip_tos_to_server: description: @@ -1085,7 +1085,7 @@ fastl4_profiles: - This option specifies the ToS level that the traffic management system assigns to IP packets when sending them to servers. returned: changed - type: string or int + type: str or int sample: pass-through ttl_mode: description: @@ -1099,7 +1099,7 @@ fastl4_profiles: - When C(set), sets the outgoing IP Header TTL value to a specific value(as specified by C(ttl_v4) or C(ttl_v6). returned: changed - type: string + type: str sample: preserve ttl_v4: description: @@ -1193,7 +1193,7 @@ fastl4_profiles: description: - Specifies the Packet Velocity(r) ASIC acceleration policy. returned: changed - type: string + type: str sample: full pva_dynamic_client_packets: description: @@ -1237,7 +1237,7 @@ fastl4_profiles: - When C(establish), implies TCP 3WAY handshaking or UDP CS round trip are confirmed. returned: changed - type: string + type: str sample: embryonic reassemble_fragments: description: @@ -1351,13 +1351,13 @@ fastl4_profiles: description: - Specifies how you want to handle the TCP timestamp. returned: changed - type: string + type: str sample: preserve tcp_window_scale_mode: description: - Specifies how you want to handle the TCP window scale. returned: changed - type: string + type: str sample: preserve timeout_recovery: description: @@ -1368,7 +1368,7 @@ fastl4_profiles: - When C(fallback), the normal FastL4 load-balancing methods are acceptable to pick a server. returned: changed - type: string + type: str sample: fallback sample: hash/dictionary of values gateway_icmp_monitors: @@ -1380,25 +1380,25 @@ gateway_icmp_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/gateway_icmp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: gateway_icmp parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: gateway_icmp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor adaptive: description: @@ -1409,7 +1409,7 @@ gateway_icmp_monitors: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). - type: string + type: str sample: relative adaptive_divergence_value: description: @@ -1433,7 +1433,7 @@ gateway_icmp_monitors: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" interval: description: @@ -1484,19 +1484,19 @@ gtm_pools: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/pool1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: pool1 alternate_mode: description: - The load balancing mode that the system uses to load balance name resolution requests among the members of the pool. - type: string + type: str sample: drop-packet dynamic_ratio: description: @@ -1517,12 +1517,12 @@ gtm_pools: - Specifies the load balancing mode that the system uses to load balance name resolution amongst the pool members if the preferred and alternate modes are unsuccessful in picking a pool. - type: string + type: str load_balancing_mode: description: - Specifies the preferred load balancing mode that the system uses to load balance requests across pool members. - type: string + type: str manual_resume: description: - Whether manual resume is enabled for this pool @@ -1604,18 +1604,18 @@ gtm_servers: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/server1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: server1 datacenter: description: - Full name of the datacenter this server belongs to. - type: string + type: str enabled: description: - Whether the server is enabled. @@ -1686,7 +1686,7 @@ gtm_servers: link_discovery: description: - Specifies whether the system auto-discovers the links for this server. - type: string + type: str monitors: description: - Specifies health monitors that the system uses to determine whether this @@ -1698,7 +1698,7 @@ gtm_servers: description: - Whether one or monitors need to pass, or all monitors need to pass. returned: changed - type: string + type: str sample: and_list product: description: @@ -1713,7 +1713,7 @@ gtm_servers: virtual_server_discovery: description: - Whether the system auto-discovers the virtual servers for this server. - type: string + type: str addresses: description: - Specifies the server IP addresses for the server. @@ -1739,13 +1739,13 @@ gtm_wide_ips: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/wide1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: wide1 description: description: @@ -1806,25 +1806,25 @@ http_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/http name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: http parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: http description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor adaptive: description: @@ -1835,7 +1835,7 @@ http_monitors: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). - type: string + type: str sample: relative adaptive_divergence_value: description: @@ -1859,7 +1859,7 @@ http_monitors: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" interval: description: @@ -1883,14 +1883,14 @@ http_monitors: description: - Specifies the text string that the monitor looks for in the returned resource. - type: string + type: str sample: check string receive_disable_string: description: - Specifies a text string that the monitor looks for in the returned resource. If the text string is matched in the returned resource, the corresponding node or pool member is marked session disabled. - type: string + type: str sample: check disable string reverse: description: @@ -1903,7 +1903,7 @@ http_monitors: description: - Specifies the text string that the monitor sends to the target object. - type: string + type: str sample: "GET /\\r\\n" time_until_up: description: @@ -1932,7 +1932,7 @@ http_monitors: description: - Specifies the username, if the monitored target requires authentication. - type: string + type: str sample: user1 sample: hash/dictionary of values https_monitors: @@ -1944,25 +1944,25 @@ https_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/http name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: http parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: http description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor adaptive: description: @@ -1973,7 +1973,7 @@ https_monitors: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). - type: string + type: str sample: relative adaptive_divergence_value: description: @@ -1997,7 +1997,7 @@ https_monitors: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" interval: description: @@ -2021,14 +2021,14 @@ https_monitors: description: - Specifies the text string that the monitor looks for in the returned resource. - type: string + type: str sample: check string receive_disable_string: description: - Specifies a text string that the monitor looks for in the returned resource. If the text string is matched in the returned resource, the corresponding node or pool member is marked session disabled. - type: string + type: str sample: check disable string reverse: description: @@ -2041,12 +2041,12 @@ https_monitors: description: - Specifies the text string that the monitor sends to the target object. - type: string + type: str sample: "GET /\\r\\n" ssl_profile: description: - Specifies the SSL profile to use for the HTTPS monitor. - type: string + type: str sample: /Common/serverssl time_until_up: description: @@ -2075,7 +2075,7 @@ https_monitors: description: - Specifies the username, if the monitored target requires authentication. - type: string + type: str sample: user1 sample: hash/dictionary of values http_profiles: @@ -2087,25 +2087,25 @@ http_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/http name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: http parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: http description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile accept_xff: description: @@ -2130,7 +2130,7 @@ http_profiles: exceeded by the client. - When C(reject), rejects the connection. returned: changed - type: string + type: str sample: reject excess_server_headers: description: @@ -2138,7 +2138,7 @@ http_profiles: exceeded by the server. - When C(reject), rejects the connection. returned: changed - type: string + type: str sample: reject known_methods: description: @@ -2175,33 +2175,33 @@ http_profiles: - Specifies the pass-through behavior when the C(max_header_size) value is exceeded by the client. returned: changed - type: string + type: str sample: reject oversize_server_headers: description: - Specifies the pass-through behavior when the C(max_header_size) value is exceeded by the server. returned: changed - type: string + type: str sample: reject pipeline_action: description: - Enables or disables HTTP/1.1 pipelining. returned: changed - type: string + type: str sample: allow unknown_method: description: - Specifies the behavior (allow, reject, or pass through) when an unknown HTTP method is parsed. returned: changed - type: string + type: str sample: allow default_connect_handling: description: - Specifies the behavior of the proxy service when handling outbound requests. returned: changed - type: string + type: str sample: deny hsts_include_subdomains: description: @@ -2240,32 +2240,32 @@ http_profiles: description: - Specifies the proxy mode for this profile. Either reverse, explicit, or transparent. returned: changed - type: string + type: str sample: reverse redirect_rewrite: description: - Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses returned: changed - type: string + type: str sample: none request_chunking: description: - Specifies how the system handles HTTP content that is chunked by a client. returned: changed - type: string + type: str sample: preserve response_chunking: description: - Specifies how the system handles HTTP content that is chunked by a server. returned: changed - type: string + type: str sample: selective server_agent_name: description: - Specifies the string used as the server name in traffic generated by LTM. returned: changed - type: string + type: str sample: BigIP sflow_poll_interval: description: @@ -2284,14 +2284,14 @@ http_profiles: - Specifies whether to Remove, Preserve, or Append Via headers included in a client request to an origin web server. returned: changed - type: string + type: str sample: preserve via_response: description: - Specifies whether to Remove, Preserve, or Append Via headers included in an origin web server response to a client. returned: changed - type: string + type: str sample: preserve sample: hash/dictionary of values iapp_services: @@ -2303,19 +2303,19 @@ iapp_services: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/service1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: service1 device_group: description: - The device group the iApp service is part of. returned: changed - type: string + type: str sample: /Common/dg1 inherited_device_group: description: @@ -2346,7 +2346,7 @@ iapp_services: description: - Traffic group the service is a part of. returned: changed - type: string + type: str sample: /Common/tg tables: description: @@ -2376,7 +2376,7 @@ iapp_services: description: - Description of the service returned: changed - type: string + type: str sample: My service sample: hash/dictionary of values icmp_monitors: @@ -2388,25 +2388,25 @@ icmp_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/icmp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: icmp parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: icmp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor adaptive: description: @@ -2417,7 +2417,7 @@ icmp_monitors: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). - type: string + type: str sample: relative adaptive_divergence_value: description: @@ -2441,7 +2441,7 @@ icmp_monitors: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" interval: description: @@ -2489,45 +2489,45 @@ interfaces: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/irul1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: irule1 active_media_type: description: - Displays the current media setting for the interface. returned: changed - type: string + type: str sample: 100TX-FD flow_control: description: - Specifies how the system controls the sending of PAUSE frames for flow control. returned: changed - type: string + type: str sample: tx-rx description: description: - Description of the interface returned: changed - type: string + type: str sample: My interface bundle: description: - The bundle capability on the port. returned: changed - type: string + type: str sample: not-supported bundle_speed: description: - The bundle-speed on the port when bundle capability is enabled. returned: changed - type: string + type: str sample: 100G enabled: description: @@ -2546,20 +2546,20 @@ interfaces: - Displays the 6-byte ethernet address in non-case-sensitive hexadecimal colon notation. returned: changed - type: string + type: str sample: "00:0b:09:88:00:9a" media_sfp: description: - The settings for an SFP (pluggable) interface. returned: changed - type: string + type: str sample: auto lldp_admin: description: - Sets the sending or receiving of LLDP packets on that interface. Should be one of C(disable), C(txonly), C(rxonly) or C(txrx). returned: changed - type: string + type: str sample: txonly mtu: description: @@ -2574,7 +2574,7 @@ interfaces: - Indicates which side of a combo port the interface uses, if both sides of the port have the potential for external links. returned: changed - type: string + type: str sample: sfp sflow_poll_interval: description: @@ -2606,7 +2606,7 @@ interfaces: description: - Specifies the STP link type for the interface. returned: changed - type: string + type: str sample: auto sample: hash/dictionary of values irules: @@ -2618,13 +2618,13 @@ irules: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/irul1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: irule1 ignore_verification: description: @@ -2636,19 +2636,19 @@ irules: description: - Checksum of the iRule as calculated by BIG-IP. returned: changed - type: string + type: str sample: d41d8cd98f00b204e9800998ecf8427e definition: description: - The actual definition of the iRule. returned: changed - type: string + type: str sample: when HTTP_REQUEST ... signature: description: - The calculated signature of the iRule. returned: changed - type: string + type: str sample: WsYy2M6xMqvosIKIEH/FSsvhtWMe6xKOA6i7f... sample: hash/dictionary of values ltm_pools: @@ -2708,7 +2708,7 @@ ltm_pools: description: - The availability of the pool. returned: changed - type: string + type: str sample: offline allow_nat: description: @@ -2728,7 +2728,7 @@ ltm_pools: based on the targeted pool. - Values can range from C(0) to C(255), or be set to C(pass-through) or C(mimic). returned: changed - type: string + type: str sample: pass-through client_link_qos: description: @@ -2736,7 +2736,7 @@ ltm_pools: based on the targeted pool. - Values can range from C(0) to C(7), or be set to C(pass-through). returned: changed - type: string + type: str sample: pass-through current_sessions: descriptions: @@ -2748,19 +2748,19 @@ ltm_pools: description: - Description of the pool. returned: changed - type: string + type: str sample: my pool enabled_status: description: - The enabled-ness of the pool. returned: changed - type: string + type: str sample: enabled full_path: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/pool1 ignore_persisted_weight: description: @@ -2772,7 +2772,7 @@ ltm_pools: description: - Load balancing method used by the pool. returned: changed - type: string + type: str sample: round-robin member_count: description: @@ -2804,7 +2804,7 @@ ltm_pools: - The action to take if the C(minimum_up_members_checking) is enabled and the number of active pool members falls below the number specified in C(minimum_up_members). returned: changed - type: string + type: str sample: failover minimum_up_members_checking: description: @@ -2816,7 +2816,7 @@ ltm_pools: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: pool1 pool_avg_queue_entry_age: description: @@ -2886,7 +2886,7 @@ ltm_pools: can be considered a generalization of all available sessions, instead of the specific value of the session. returned: changed - type: string + type: str sample: monitor-enabled real_state: description: @@ -2895,7 +2895,7 @@ ltm_pools: can be considered a generalization of all available states, instead of the specific value of the state. returned: changed - type: string + type: str sample: up reselect_tries: description: @@ -2907,19 +2907,19 @@ ltm_pools: description: - The Type of Service (ToS) level to use when sending packets to a server. returned: changed - type: string + type: str sample: pass-through server_link_qos: description: - The Quality of Service (QoS) level to use when sending packets to a server. returned: changed - type: string + type: str sample: pass-through service_down_action: description: - The action to take if the service specified in the pool is marked down. returned: changed - type: string + type: str sample: none server_side_bits_in: description: @@ -2975,7 +2975,7 @@ ltm_pools: description: - If there is a problem with the status of the pool, that problem is reported here. returned: changed - type: string + type: str sample: The children pool member(s) are down. members: description: List of LTM (Local Traffic Manager) pools. @@ -2985,7 +2985,7 @@ ltm_pools: address: description: IP address of the pool member. returned: changed - type: string + type: str sample: 1.1.1.1 connection_limit: description: The maximum number of concurrent connections allowed for a pool member. @@ -2995,7 +2995,7 @@ ltm_pools: description: description: The description of the pool member. returned: changed - type: string + type: str sample: pool member 1 dynamic_ratio: description: @@ -3020,7 +3020,7 @@ ltm_pools: - Full name of the resource as known to BIG-IP. - Includes the port in the name returned: changed - type: string + type: str sample: "/Common/member:80" inherit_profile: description: @@ -3044,13 +3044,13 @@ ltm_pools: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: "member:80" partition: description: - Partition that the member exists on. returned: changed - type: string + type: str sample: Common priority_group: description: @@ -3062,7 +3062,7 @@ ltm_pools: description: - The encapsulation profile to use for the pool member. returned: changed - type: string + type: str sample: ip4ip4 rate_limit: description: @@ -3080,13 +3080,13 @@ ltm_pools: description: - Enables or disables the pool member for new sessions. returned: changed - type: string + type: str sample: monitor-enabled state: description: - Controls the state of the pool member, overriding any monitors. returned: changed - type: string + type: str sample: down total_requests: description: @@ -3104,13 +3104,13 @@ nodes: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/5.6.7.8 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: 5.6.7.8 ratio: description: @@ -3122,7 +3122,7 @@ nodes: description: - Description of the node. returned: changed - type: string + type: str sample: My node connection_limit: description: @@ -3134,7 +3134,7 @@ nodes: description: - IP address of the node. returned: changed - type: string + type: str sample: 2.3.4.5 dynamic_ratio: description: @@ -3153,37 +3153,37 @@ nodes: - Status of the node as reported by the monitor(s) associated with it. - This value is also used in determining node C(state). returned: changed - type: string + type: str sample: down session_status: description: - This value is also used in determining node C(state). returned: changed - type: string + type: str sample: enabled availability_status: description: - The availability of the node. returned: changed - type: string + type: str sample: offline enabled_status: description: - The enabled-ness of the node. returned: changed - type: string + type: str sample: enabled status_reason: description: - If there is a problem with the status of the node, that problem is reported here. returned: changed - type: string + type: str sample: /Common/https_443 No successful responses received... monitor_rule: description: - A string representation of the full monitor rule. returned: changed - type: string + type: str sample: /Common/https_443 and /Common/icmp monitors: description: @@ -3196,7 +3196,7 @@ nodes: - The C(monitor_type) field related to the C(bigip_node) module, for this nodes monitors. returned: changed - type: string + type: str sample: and_list sample: hash/dictionary of values oneconnect_profiles: @@ -3208,25 +3208,25 @@ oneconnect_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/oneconnect name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: oneconnect parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: oneconnect description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile idle_timeout_override: description: @@ -3246,7 +3246,7 @@ oneconnect_profiles: connections from being made until they expire, even if they could otherwise be reused. returned: changed - type: string + type: str sample: idle max_age: description: @@ -3283,7 +3283,7 @@ oneconnect_profiles: - Specifies a source IP mask. - If no mask is provided, the value C(any6) is used. returned: changed - type: string + type: str sample: 255.255.255.0 sample: hash/dictionary of values partitions: @@ -3295,19 +3295,19 @@ partitions: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: Common name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: Common description: description: - Description of the partition. returned: changed - type: string + type: str sample: Tenant 1 default_route_domain: description: @@ -3326,13 +3326,13 @@ provision_info: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: asm name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: asm cpu_ratio: description: @@ -3376,25 +3376,25 @@ self_ips: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/self1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: self1 description: description: - Description of the Self-IP. returned: changed - type: string + type: str sample: My self-ip netmask: description: - Netmask portion of the IP address. In dotted notation. returned: changed - type: string + type: str sample: 255.255.255.0 netmask_cidr: description: @@ -3412,19 +3412,19 @@ self_ips: description: - Traffic group the Self-IP is associated with. returned: changed - type: string + type: str sample: /Common/traffic-group-local-only service_policy: description: - Service policy assigned to the Self-IP. returned: changed - type: string + type: str sample: /Common/service1 vlan: description: - VLAN associated with the Self-IP. returned: changed - type: string + type: str sample: /Common/vlan1 allow_access_list: description: @@ -3451,32 +3451,32 @@ server_ssl_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: serverssl name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: serverssl description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: serverssl alert_timeout: description: - Maximum time period in seconds to keep the SSL session active after alert message is sent, or indefinite. returned: changed - type: string + type: str sample: 100 allow_expired_crl: description: @@ -3488,7 +3488,7 @@ server_ssl_profiles: description: - Specifies the frequency of authentication. returned: changed - type: string + type: str sample: once authenticate_depth: description: @@ -3501,7 +3501,7 @@ server_ssl_profiles: - Common Name (CN) that is embedded in a server certificate. - The system authenticates a server based on the specified CN. returned: changed - type: string + type: str sample: foo bypass_on_client_cert_fail: description: @@ -3521,14 +3521,14 @@ server_ssl_profiles: - Name of the certificate file that is used as the certification authority certificate when SSL client certificate constrained delegation is enabled. - type: string + type: str sample: /Common/cacert.crt c3d_ca_key: description: - Name of the key file that is used as the certification authority key when SSL client certificate constrained delegation is enabled. - type: string + type: str sample: /Common/default.key c3d_cert_extension_includes: description: @@ -3546,7 +3546,7 @@ server_ssl_profiles: ca_file: description: - Certificate authority file name. - type: string + type: str sample: default.crt cache_size: description: @@ -3564,49 +3564,49 @@ server_ssl_profiles: - The name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection. - type: string + type: str sample: /Common/default.crt chain: description: - Specifies or builds a certificate chain file that a client can use to authenticate the profile. - type: string + type: str sample: /Common/default.crt cipher_group: description: - Specifies a cipher group. - type: string + type: str ciphers: description: - Specifies a cipher name - type: string + type: str sample: DEFAULT crl_file: description: - Specifies the certificate revocation list file name. - type: string + type: str expire_cert_response_control: description: - Specifies the BIGIP action when the server certificate has expired. - type: string + type: str sample: drop handshake_timeout: description: - Specifies the handshake timeout in seconds. - type: string + type: str sample: 10 key: description: - Specifies the key file name. Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection. - type: string + type: str sample: /Common/default.key max_active_handshakes: description: - Specifies the maximum number allowed SSL active handshakes. - type: string + type: str sample: 100 mod_ssl_methods: description: @@ -3622,7 +3622,7 @@ server_ssl_profiles: description: - Specifies the name of ocsp profile for purpose of validating status of server certificate. - type: string + type: str options: description: - Enables options, including some industry-related workarounds. @@ -3631,7 +3631,7 @@ server_ssl_profiles: peer_cert_mode: description: - Specifies the peer certificate mode. - type: string + type: str sample: ignore proxy_ssl: description: @@ -3650,12 +3650,12 @@ server_ssl_profiles: description: - Number of seconds from the initial connect time after which the system renegotiates an SSL session. - type: string + type: str sample: indefinite renegotiate_size: description: - Specifies a throughput size, in megabytes, of SSL renegotiation. - type: string + type: str sample: indefinite renegotiation: description: @@ -3676,13 +3676,13 @@ server_ssl_profiles: secure_renegotiation: description: - Specifies the secure renegotiation mode. - type: string + type: str sample: require server_name: description: - Server name to be included in SNI (server name indication) extension during SSL handshake in ClientHello. - type: string + type: str session_mirroring: description: - Enables or disables the mirroring of sessions to high availability @@ -3723,7 +3723,7 @@ server_ssl_profiles: - Specifies SSL sign hash algorithm which is used to sign and verify SSL Server Key Exchange and Certificate Verify messages for the specified SSL profiles. - type: string + type: str sample: sha1 ssl_forward_proxy_bypass: description: @@ -3748,7 +3748,7 @@ server_ssl_profiles: description: - Specifies the BIGIP action when the server certificate has untrusted CA. - type: string + type: str sample: drop sample: hash/dictionary of values software_hotfixes: @@ -3760,20 +3760,20 @@ software_hotfixes: description: - Name of the image. returned: changed - type: string + type: str sample: Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso full_path: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso build: description: - Build number of the image. - This is usually a sub-string of the C(name). returned: changed - type: string + type: str sample: 3.0.1679 checksum: description: @@ -3781,26 +3781,26 @@ software_hotfixes: - Note that this is the checksum that is stored inside the ISO. It is not the actual checksum of the ISO. returned: changed - type: string + type: str sample: df1ec715d2089d0fa54c0c4284656a98 product: description: - Product contained in the ISO. returned: changed - type: string + type: str sample: BIG-IP id: description: - ID component of the image. - This is usually a sub-string of the C(name). returned: changed - type: string + type: str sample: HF3 title: description: - Human friendly name of the image. returned: changed - type: string + type: str sample: Hotfix Version 3.0.1679 verified: description: @@ -3813,7 +3813,7 @@ software_hotfixes: - Version of software contained in the image. - This is a sub-string of the C(name). returned: changed - type: string + type: str sample: 13.0.0 sample: hash/dictionary of values software_images: @@ -3825,26 +3825,26 @@ software_images: description: - Name of the image. returned: changed - type: string + type: str sample: BIGIP-13.1.0.7-0.0.1.iso full_path: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: BIGIP-13.1.0.7-0.0.1.iso build: description: - Build number of the image. - This is usually a sub-string of the C(name). returned: changed - type: string + type: str sample: 0.0.1 build_date: description: - Date of the build. returned: changed - type: string + type: str sample: "2018-05-05T15:26:30" checksum: description: @@ -3852,7 +3852,7 @@ software_images: - Note that this is the checksum that is stored inside the ISO. It is not the actual checksum of the ISO. returned: changed - type: string + type: str sample: df1ec715d2089d0fa54c0c4284656a98 file_size: description: @@ -3864,13 +3864,13 @@ software_images: description: - Last modified date of the ISO. returned: changed - type: string + type: str sample: "2018-05-05T15:26:30" product: description: - Product contained in the ISO. returned: changed - type: string + type: str sample: BIG-IP verified: description: @@ -3883,7 +3883,7 @@ software_images: - Version of software contained in the image. - This is a sub-string of the C(name). returned: changed - type: string + type: str sample: 13.1.0.7 sample: hash/dictionary of values software_volumes: @@ -3904,19 +3904,19 @@ software_volumes: - When a hotfix is installed, this refers to the base version of software that the hotfix requires. returned: changed - type: string + type: str sample: 0.0.6 build: description: - Build version of the software installed in the volume. returned: changed - type: string + type: str sample: 0.0.6 full_path: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: HD1.1 default_boot_location: description: @@ -3929,27 +3929,27 @@ software_volumes: - Relative name of the resource in BIG-IP. - This usually matches the C(full_name). returned: changed - type: string + type: str sample: HD1.1 product: description: - The F5 product installed in this slot. - This should always be BIG-IP. returned: changed - type: string + type: str sample: BIG-IP status: description: - Status of the software installed, or being installed, in the volume. - When C(complete), indicates that the software has completed installing. returned: changed - type: string + type: str sample: complete version: description: - Version of software installed in the volume, excluding the C(build) number. returned: changed - type: string + type: str sample: 13.1.0.4 sample: hash/dictionary of values ssl_certs: @@ -3961,19 +3961,19 @@ ssl_certs: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/cert1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: cert1 key_type: description: - Specifies the type of cryptographic key associated with this certificate. returned: changed - type: string + type: str sample: rsa-private key_size: description: @@ -3985,32 +3985,32 @@ ssl_certs: description: - Path on the BIG-IP where the cert can be found. returned: changed - type: string + type: str sample: /config/ssl/ssl.crt/f5-irule.crt sha1_checksum: description: - SHA1 checksum of the certificate. returned: changed - type: string + type: str sample: 1306e84e1e6a2da53816cefe1f684b80d6be1e3e subject: description: - Specifies X509 information of the certificate's subject. returned: changed - type: string + type: str sample: "emailAddress=support@f5.com,CN=..." last_update_time: description: - Specifies the last time at which the file-object was updated/modified. returned: changed - type: string + type: str sample: "2018-05-15T21:11:15Z" issuer: description: - Specifies X509 information of the certificate's issuer. returned: changed - type: string + type: str sample: "emailAddress=support@f5.com,...CN=support.f5.com," is_bundle: description: @@ -4023,14 +4023,14 @@ ssl_certs: description: - Displays the SHA-256 fingerprint of the certificate. returned: changed - type: string + type: str sample: "SHA256/88:A3:05:...:59:01:EA:5D:B0" expiration_date: description: - Specifies a string representation of the expiration date of the certificate. returned: changed - type: string + type: str sample: "Aug 13 21:21:29 2031 GMT" expiration_timestamp: description: @@ -4043,7 +4043,7 @@ ssl_certs: description: - Specifies the time at which the file-object was created. returned: changed - type: string + type: str sample: "2018-05-15T21:11:15Z" sample: hash/dictionary of values ssl_keys: @@ -4055,20 +4055,20 @@ ssl_keys: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/key1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: key1 key_type: description: - Specifies the cryptographic type of the key in question. That is, which algorithm this key is compatible with. returned: changed - type: string + type: str sample: rsa-private key_size: description: @@ -4081,19 +4081,19 @@ ssl_keys: description: - Specifies the type of security used to handle or store the key. returned: changed - type: string + type: str sample: normal system_path: description: - The path on the filesystem where the key is stored. returned: changed - type: string + type: str sample: /config/ssl/ssl.key/default.key sha1_checksum: description: - The SHA1 checksum of the key. returned: changed - type: string + type: str sample: 1fcf7de3dd8e834d613099d8e10b2060cd9ecc9f sample: hash/dictionary of values system_db: @@ -4105,37 +4105,37 @@ system_db: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: vendor.wwwurl name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: vendor.wwwurl default: description: - Default value of the key. returned: changed - type: string + type: str sample: www.f5.com scf_config: description: - Whether the database key would be found in an SCF config or not. returned: changed - type: string + type: str sample: false value: description: - The value of the key returned: changed - type: string + type: str sample: www.f5.com value_range: description: - The accepted range of values for the key returned: changed - type: string + type: str sample: string sample: hash/dictionary of values system_info: @@ -4147,13 +4147,13 @@ system_info: description: - Media Access Control address (MAC address) of the device. returned: changed - type: string + type: str sample: "fa:16:3e:c3:42:6f" marketing_name: description: - Marketing name of the device platform. returned: changed - type: string + type: str sample: BIG-IP Virtual Edition time: description: @@ -4206,17 +4206,17 @@ system_info: model: description: - The model of the hardware. - type: string + type: str sample: Virtual Disk name: description: - The name of the hardware. - type: string + type: str sample: HD1 type: description: - The type of hardware. - type: string + type: str sample: physical-disk versions: description: @@ -4226,38 +4226,38 @@ system_info: name: description: - Name of the property - type: string + type: str sample: Size version: description: - Value of the property - type: string + type: str sample: 154.00G package_edition: description: - Displays the software edition. returned: changed - type: string + type: str sample: Point Release 7 package_version: description: - A string combining the C(product_build) and C(product_build_date). - type: string + type: str sample: "Build 0.0.1 - Tue May 15 15:26:30 PDT 2018" product_code: description: - Code identifying the product. - type: string + type: str sample: BIG-IP product_build: description: - Build version of the release version. - type: string + type: str sample: 0.0.1 product_version: description: - Major product version of the running software. - type: string + type: str sample: 13.1.0.7 product_built: description: @@ -4267,7 +4267,7 @@ system_info: product_build_date: description: - Human readable build date. - type: string + type: str sample: "Tue May 15 15:26:30 PDT 2018" product_changelist: description: @@ -4282,29 +4282,29 @@ system_info: chassis_serial: description: - Serial of the chassis - type: string + type: str sample: 11111111-2222-3333-444444444444 host_board_part_revision: description: - Revision of the host board. - type: string + type: str host_board_serial: description: - Serial of the host board. - type: string + type: str platform: description: - Platform identifier. - type: string + type: str sample: Z100 switch_board_part_revision: description: - Switch board revision. - type: string + type: str switch_board_serial: description: - Serial of the switch board. - type: string + type: str uptime: description: - Time, in seconds, since the system booted. @@ -4320,25 +4320,25 @@ tcp_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/tcp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: tcp parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: tcp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor adaptive: description: @@ -4349,7 +4349,7 @@ tcp_monitors: description: - Specifies whether the adaptive-divergence-value is C(relative) or C(absolute). - type: string + type: str sample: relative adaptive_divergence_value: description: @@ -4373,7 +4373,7 @@ tcp_monitors: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" interval: description: @@ -4433,31 +4433,31 @@ tcp_half_open_monitors: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/tcp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: tcp parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: tcp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My monitor destination: description: - Specifies the IP address and service port of the resource that is the destination of this monitor. - type: string + type: str sample: "*:*" interval: description: @@ -4505,25 +4505,25 @@ tcp_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: tcp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: /Common/tcp parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: tcp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile abc: description: @@ -4566,7 +4566,7 @@ tcp_profiles: after entering the LAST-ACK state. - When C(indefinite), specifies that TCP connections in the LAST-ACK state do not close until they meet the maximum retransmissions timeout. - type: string + type: str sample: indefinite congestion_metrics_cache: description: @@ -4589,7 +4589,7 @@ tcp_profiles: - Return values may include, C(high-speed), C(cdg), C(chd), C(none), C(cubic), C(illinois), C(new-reno), C(reno), C(scalable), C(vegas), C(westwood), and C(woodside). - type: string + type: str sample: high-speed deferred_accept: description: @@ -4655,19 +4655,19 @@ tcp_profiles: description: - Specifies the length of time that a TCP connection is in the FIN-WAIT-1 or CLOSING state before quitting. - type: string + type: str sample: indefinite fin_wait_2: description: - Specifies the length of time that a TCP connection is in the FIN-WAIT-2 state before quitting. - type: string + type: str sample: 100 idle_timeout: description: - Specifies the length of time that a connection is idle (has no traffic) before the connection is eligible for deletion. - type: string + type: str sample: 300 initial_congestion_window_size: description: @@ -4683,18 +4683,18 @@ tcp_profiles: description: - Specifies the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. - type: string + type: str sample: pmtu ip_tos: description: - Specifies the L3 Type of Service (ToS) level that the system inserts in TCP packets destined for clients. - type: string + type: str sample: mimic time_to_live: description: - Specifies the outgoing TCP packet's IP Header TTL mode. - type: string + type: str sample: proxy time_to_live_v4: description: @@ -4710,7 +4710,7 @@ tcp_profiles: description: - Specifies how frequently the system sends data over an idle TCP connection, to determine whether the connection is still valid. - type: string + type: str sample: 50 limited_transmit_recovery: description: @@ -4723,7 +4723,7 @@ tcp_profiles: description: - Specifies the L2 Quality of Service (QoS) level that the system inserts in TCP packets destined for clients. - type: string + type: str sample: 200 max_segment_retrans: description: @@ -4777,7 +4777,7 @@ tcp_profiles: description: - Specifies an action on fallback, that is, when MPTCP transitions to regular TCP, because something prevents MPTCP from working correctly. - type: string + type: str sample: reset mptcp_fast_join: description: @@ -4881,7 +4881,7 @@ tcp_profiles: push_flag: description: - Specifies how the BIG-IP system receives ACKs. - type: string + type: str sample: default rate_pace: description: @@ -4974,7 +4974,7 @@ tcp_profiles: description: - Specifies the length of time that a TCP connection remains in the TIME-WAIT state before entering the CLOSED state. - type: string + type: str sample: 2000 timestamps: description: @@ -4992,7 +4992,7 @@ tcp_profiles: description: - Specifies the timeout in milliseconds for terminating a connection with an effective zero length TCP transmit window. - type: string + type: str sample: 2000 sample: hash/dictionary of values traffic_groups: @@ -5004,19 +5004,19 @@ traffic_groups: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/tg1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: tg1 description: description: - Description of the traffic group. returned: changed - type: string + type: str sample: My traffic group auto_failback_enabled: description: @@ -5057,7 +5057,7 @@ traffic_groups: description: - Specifies a MAC address for the traffic group. returned: changed - type: string + type: str sample: "00:98:76:54:32:10" sample: hash/dictionary of values trunks: @@ -5069,19 +5069,19 @@ trunks: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/trunk1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: trunk1 description: description: - Description of the Trunk. returned: changed - type: string + type: str sample: My trunk media_speed: description: @@ -5093,7 +5093,7 @@ trunks: description: - The operation mode for LACP. returned: changed - type: string + type: str sample: passive lacp_enabled: description: @@ -5124,7 +5124,7 @@ trunks: - The LACP policy that the trunk uses to determine which member link can handle new traffic. returned: changed - type: string + type: str sample: maximum-bandwidth lacp_timeout: description: @@ -5144,7 +5144,7 @@ trunks: - The system uses this hash to determine which interface to use for forwarding traffic. returned: changed - type: string + type: str sample: src-dst-ipport configured_member_count: description: @@ -5162,25 +5162,25 @@ udp_profiles: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: udp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: /Common/udp parent: description: - Profile from which this profile inherits settings. returned: changed - type: string + type: str sample: udp description: description: - Description of the resource. returned: changed - type: string + type: str sample: My profile allow_no_payload: description: @@ -5226,7 +5226,7 @@ udp_profiles: - When C(set), sets the outgoing UDP packet DF bit. - When C(clear), clears the outgoing UDP packet DF bit. returned: changed - type: string + type: str sample: pmtu ip_tos_to_client: description: @@ -5234,7 +5234,7 @@ udp_profiles: system assigns to UDP packets when sending them to clients. - May be numeric, or the values C(pass-through) or C(mimic). returned: changed - type: string + type: str sample: mimic ip_ttl_mode: description: @@ -5247,7 +5247,7 @@ udp_profiles: - When C(set), set the IP TTL with the specified values in C(ip_ttl_v4) and C(ip_ttl_v6) values in the same profile. returned: changed - type: string + type: str sample: proxy ip_ttl_v4: description: @@ -5267,7 +5267,7 @@ udp_profiles: UDP packets when sending them to clients. - May be either numberic, or the value C(pass-through). returned: changed - type: string + type: str sample: pass-through no_checksum: description: @@ -5294,13 +5294,13 @@ vcmp_guests: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: guest1 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: guest1 allowed_slots: description: @@ -5330,37 +5330,37 @@ vcmp_guests: description: - FQDN assigned to the guest. returned: changed - type: string + type: str sample: guest1.localdomain hotfix_image: description: - hotfix image to install onto any of this guest's newly created virtual disks. returned: changed - type: string + type: str sample: Hotfix-BIGIP-12.1.3.4-0.0.2-hf1.iso initial_image: description: - Software image to install onto any of this guest's newly created virtual disks. returned: changed - type: string + type: str sample: BIGIP-12.1.3.4-0.0.2.iso mgmt_route: description: - Management gateway IP address for the guest. returned: changed - type: string + type: str sample: 2.2.2.1 mgmt_address: description: - Management IP address configuration for the guest. returned: changed - type: string + type: str sample: 2.3.2.3 mgmt_network: description: - Accessibility of this vCMP guest's management network. returned: changed - type: string + type: str sample: bridged min_number_of_slots: description: @@ -5379,7 +5379,7 @@ vcmp_guests: description: - The SSL hardware allocation mode for the guest. returned: changed - type: string + type: str sample: shared state: description: @@ -5387,13 +5387,13 @@ vcmp_guests: - May be one of C(configured), C(provisioned), or C(deployed). - Each state implies the actions of all states before it. returned: changed - type: string + type: str sample: provisioned virtual_disk: description: - The filename of the virtual disk to use for this guest. returned: changed - type: string + type: str sample: guest1.img sample: hash/dictionary of values virtual_addresses: @@ -5405,19 +5405,19 @@ virtual_addresses: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/2.3.4.5 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: 2.3.4.5 address: description: - The virtual IP address. returned: changed - type: string + type: str sample: 2.3.4.5 arp_enabled: description: @@ -5443,7 +5443,7 @@ virtual_addresses: description: - The description of the virtual address. returned: changed - type: string + type: str sample: My virtual address enabled: description: @@ -5469,7 +5469,7 @@ virtual_addresses: description: - Netmask of the virtual address. returned: changed - type: string + type: str sample: 255.255.255.255 route_advertisement: description: @@ -5481,7 +5481,7 @@ virtual_addresses: description: - Traffic group on which the virtual address is active. returned: changed - type: string + type: str sample: /Common/traffic-group-1 spanning: description: @@ -5505,19 +5505,19 @@ virtual_servers: description: - The availability of the virtual server. returned: changed - type: string + type: str sample: offline full_path: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/2.3.4.5 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: 2.3.4.5 auto_lasthop: description: @@ -5525,14 +5525,14 @@ virtual_servers: that transmitted the request, even if the routing table points to a different network or interface. returned: changed - type: string + type: str sample: default bw_controller_policy: description: - The bandwidth controller for the system to use to enforce a throughput policy for incoming network traffic. returned: changed - type: string + type: str sample: /Common/bw1 client_side_bits_in: description: @@ -5598,7 +5598,7 @@ virtual_servers: description: - The clustered-multiprocessing mode. returned: changed - type: string + type: str sample: all-cpus connection_limit: description: @@ -5610,7 +5610,7 @@ virtual_servers: description: - The description of the virtual server. returned: changed - type: string + type: str sample: My virtual enabled: description: @@ -5766,21 +5766,21 @@ virtual_servers: description: - SYN Cookies Status returned: changed - type: string + type: str sample: not-activated fallback_persistence_profile: description: - Fallback persistence profile for the virtual server to use when the default persistence profile is not available. returned: changed - type: string + type: str sample: /Common/fallback1 persistence_profile: description: - The persistence profile you want the system to use as the default for this virtual server. returned: changed - type: string + type: str sample: /Common/persist1 translate_port: description: @@ -5805,14 +5805,14 @@ virtual_servers: - Name of the virtual address and service on which the virtual server listens for connections. returned: changed - type: string + type: str sample: /Common/2.2.3.3%1:76 last_hop_pool: description: - Name of the last hop pool that you want the virtual server to use to direct reply traffic to the last hop router. returned: changed - type: string + type: str sample: /Common/pool1 nat64_enabled: description: @@ -5824,25 +5824,25 @@ virtual_servers: description: - Specifies whether the system preserves the source port of the connection. returned: changed - type: string + type: str sample: preserve ip_intelligence_policy: description: - IP Intelligence policy assigned to the virtual returned: changed - type: string + type: str sample: /Common/ip1 protocol: description: - IP protocol for which you want the virtual server to direct traffic. returned: changed - type: string + type: str sample: tcp default_pool: description: - Pool name that you want the virtual server to use as the default pool. returned: changed - type: string + type: str sample: /Common/pool1 rate_limit_mode: description: @@ -5850,7 +5850,7 @@ virtual_servers: per source address, per destination address, or some combination thereof. returned: changed - type: string + type: str sample: object rate_limit_source_mask: description: @@ -5870,19 +5870,19 @@ virtual_servers: - Specifies the type of source address translation associated with the specified virtual server. returned: changed - type: string + type: str sample: none snat_pool: description: - Specifies the name of a LSN or SNAT pool used by the specified virtual server. returned: changed - type: string + type: str sample: /Common/pool1 status_reason: description: - If there is a problem with the status of the virtual, that problem is reported here. returned: changed - type: string + type: str sample: The children pool member(s) either don't have service checking... gtm_score: description: @@ -5896,7 +5896,7 @@ virtual_servers: virtual server to use to enforce a throughput policy for incoming network traffic. returned: changed - type: string + type: str rate_limit_destination_mask: description: - Specifies a mask, in bits, to be applied to the destination @@ -5909,7 +5909,7 @@ virtual_servers: - Specifies an IP address or network from which the virtual server will accept traffic. returned: changed - type: string + type: str sample: 0.0.0./0 authentication_profile: description: @@ -5940,13 +5940,13 @@ virtual_servers: description: - Virtual server type. returned: changed - type: string + type: str sample: standard destination_address: description: - Address portion of the C(destination). returned: changed - type: string + type: str sample: 2.3.3.2 destination_port: description: @@ -5964,19 +5964,19 @@ virtual_servers: - Which side of the connection the profile affects; either C(all), C(client-side) or C(server-side). returned: changed - type: string + type: str sample: client-side full_path: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: /Common/tcp name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: tcp total_requests: description: @@ -5995,25 +5995,25 @@ vlans: - Allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. returned: changed - type: string + type: str sample: enabled cmp_hash_algorithm: description: - Specifies how the traffic on the VLAN will be disaggregated. returned: changed - type: string + type: str sample: default description: description: - Description of the VLAN. returned: changed - type: string + type: str sample: My vlan failsafe_action: description: - Action for the system to take when the fail-safe mechanism is triggered. returned: changed - type: string + type: str sample: reboot failsafe_enabled: description: @@ -6040,7 +6040,7 @@ vlans: - Whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped. returned: changed - type: string + type: str sample: enable-forward interfaces: description: @@ -6052,13 +6052,13 @@ vlans: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: 1.3 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: 1.3 tagged: description: @@ -6108,7 +6108,7 @@ vlans: description: - Media access control (MAC) address for the lowest-numbered interface assigned to this VLAN. returned: changed - type: string + type: str sample: "fa:16:3e:10:da:ff" tag: description: diff --git a/lib/ansible/modules/network/f5/bigip_device_group.py b/lib/ansible/modules/network/f5/bigip_device_group.py index d928603f99..ca6f274968 100644 --- a/lib/ansible/modules/network/f5/bigip_device_group.py +++ b/lib/ansible/modules/network/f5/bigip_device_group.py @@ -137,12 +137,12 @@ full_sync: description: description: The new description of the device group. returned: changed - type: string + type: str sample: this is a device group type: description: The new type of the device group. returned: changed - type: string + type: str sample: sync-failover auto_sync: description: The new auto_sync value of the device group. diff --git a/lib/ansible/modules/network/f5/bigip_device_httpd.py b/lib/ansible/modules/network/f5/bigip_device_httpd.py index 28218dc728..882a61b949 100644 --- a/lib/ansible/modules/network/f5/bigip_device_httpd.py +++ b/lib/ansible/modules/network/f5/bigip_device_httpd.py @@ -175,12 +175,12 @@ RETURN = r''' auth_pam_idle_timeout: description: The new number of seconds for GUI timeout. returned: changed - type: string + type: str sample: 1200 auth_name: description: The new authentication realm name. returned: changed - type: string + type: str sample: 'foo' auth_pam_validate_ip: description: The new authPamValidateIp setting. @@ -205,7 +205,7 @@ hostname_lookup: log_level: description: The new minimum httpd log level. returned: changed - type: string + type: str sample: crit max_clients: description: The new maximum number of clients that can connect to the GUI at once. @@ -225,17 +225,17 @@ ssl_port: ssl_cipher_suite: description: The new ciphers that the system uses. returned: changed - type: string + type: str sample: ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA ssl_cipher_suite_list: description: List of the new ciphers that the system uses. returned: changed - type: string + type: str sample: ['ECDHE-RSA-AES256-GCM-SHA384', 'ECDHE-RSA-AES128-SHA'] ssl_protocols: description: The new list of SSL protocols to accept on the management console. returned: changed - type: string + type: str sample: all -SSLv2 -SSLv3 ''' diff --git a/lib/ansible/modules/network/f5/bigip_device_ntp.py b/lib/ansible/modules/network/f5/bigip_device_ntp.py index 6698aeb370..c66d712f4a 100644 --- a/lib/ansible/modules/network/f5/bigip_device_ntp.py +++ b/lib/ansible/modules/network/f5/bigip_device_ntp.py @@ -73,7 +73,7 @@ ntp_servers: timezone: description: The timezone that was set on the device returned: changed - type: string + type: str sample: true ''' diff --git a/lib/ansible/modules/network/f5/bigip_device_sshd.py b/lib/ansible/modules/network/f5/bigip_device_sshd.py index cf60d6009e..9c2c2b2dd4 100644 --- a/lib/ansible/modules/network/f5/bigip_device_sshd.py +++ b/lib/ansible/modules/network/f5/bigip_device_sshd.py @@ -118,14 +118,14 @@ allow: banner: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true banner_text: description: - Specifies the text included on the pre-login banner that displays when a user attempts to login to the system using SSH. returned: changed and success - type: string + type: str sample: This is a corporate device. Connecting to it without... inactivity_timeout: description: @@ -137,7 +137,7 @@ inactivity_timeout: log_level: description: The minimum SSHD message level to include in the system log. returned: changed - type: string + type: str sample: debug login: description: Specifies that the system accepts SSH communications or not. diff --git a/lib/ansible/modules/network/f5/bigip_device_syslog.py b/lib/ansible/modules/network/f5/bigip_device_syslog.py index 776a1ec5ec..145fcfda2b 100644 --- a/lib/ansible/modules/network/f5/bigip_device_syslog.py +++ b/lib/ansible/modules/network/f5/bigip_device_syslog.py @@ -261,12 +261,12 @@ RETURN = r''' auth_priv_from: description: The new lowest user authentication logging level returned: changed - type: string + type: str sample: alert auth_priv_to: description: The new highest user authentication logging level. returned: changed - type: string + type: str sample: emerg console_log: description: Whether logging to console is enabled or not. @@ -281,77 +281,77 @@ iso_date: cron_from: description: The new lowest time-based scheduling logging level. returned: changed - type: string + type: str sample: emerg cron_to: description: The new highest time-based scheduling logging level. returned: changed - type: string + type: str sample: alert daemon_from: description: The new lowest daemon performance logging level. returned: changed - type: string + type: str sample: alert daemon_to: description: The new highest daemon performance logging level. returned: changed - type: string + type: str sample: alert include: description: The new extra syslog-ng configuration to include in syslog config. returned: changed - type: string + type: str sample: "filter f_remote_syslog { not (facility(local6)) };" kern_from: description: The new lowest kernel messages logging level. returned: changed - type: string + type: str sample: alert kern_to: description: The new highest kernel messages logging level. returned: changed - type: string + type: str sample: alert local6_from: description: The new lowest local6 facility logging level. returned: changed - type: string + type: str sample: alert local6_to: description: The new highest local6 facility logging level. returned: changed - type: string + type: str sample: alert mail_from: description: The new lowest mail log logging level. returned: changed - type: string + type: str sample: alert mail_to: description: The new highest mail log logging level. returned: changed - type: string + type: str sample: alert messages_from: description: The new lowest system logging level. returned: changed - type: string + type: str sample: alert messages_to: description: The new highest system logging level. returned: changed - type: string + type: str sample: alert user_log_from: description: The new lowest user account logging level. returned: changed - type: string + type: str sample: alert user_log_to: description: The new highest user account logging level. returned: changed - type: string + type: str sample: alert ''' diff --git a/lib/ansible/modules/network/f5/bigip_device_trust.py b/lib/ansible/modules/network/f5/bigip_device_trust.py index 0054ff3863..27c681d0f1 100644 --- a/lib/ansible/modules/network/f5/bigip_device_trust.py +++ b/lib/ansible/modules/network/f5/bigip_device_trust.py @@ -95,12 +95,12 @@ RETURN = r''' peer_server: description: The remote IP address of the trusted peer. returned: changed - type: string + type: str sample: 10.0.2.15 peer_hostname: description: The remote hostname used to identify the trusted peer. returned: changed - type: string + type: str sample: test-bigip-02.localhost.localdomain ''' diff --git a/lib/ansible/modules/network/f5/bigip_dns_cache_resolver.py b/lib/ansible/modules/network/f5/bigip_dns_cache_resolver.py index a2f47582ea..d97efc4ccc 100644 --- a/lib/ansible/modules/network/f5/bigip_dns_cache_resolver.py +++ b/lib/ansible/modules/network/f5/bigip_dns_cache_resolver.py @@ -103,7 +103,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_dns_nameserver.py b/lib/ansible/modules/network/f5/bigip_dns_nameserver.py index 7b7d3ea6b4..6be4d55315 100644 --- a/lib/ansible/modules/network/f5/bigip_dns_nameserver.py +++ b/lib/ansible/modules/network/f5/bigip_dns_nameserver.py @@ -89,7 +89,7 @@ RETURN = r''' address: description: Address which the nameserver listens for DNS messages. returned: changed - type: string + type: str sample: 127.0.0.1 service_port: description: Service port on which the nameserver listens for DNS messages. diff --git a/lib/ansible/modules/network/f5/bigip_dns_resolver.py b/lib/ansible/modules/network/f5/bigip_dns_resolver.py index e0cda9c18b..5e5ec5ae72 100644 --- a/lib/ansible/modules/network/f5/bigip_dns_resolver.py +++ b/lib/ansible/modules/network/f5/bigip_dns_resolver.py @@ -108,7 +108,7 @@ RETURN = r''' route_domain: description: The new route domain of the resource. returned: changed - type: string + type: str sample: /Common/0 cache_size: description: The new cache size of the resource. diff --git a/lib/ansible/modules/network/f5/bigip_dns_zone.py b/lib/ansible/modules/network/f5/bigip_dns_zone.py index a885beccf2..435fd92758 100644 --- a/lib/ansible/modules/network/f5/bigip_dns_zone.py +++ b/lib/ansible/modules/network/f5/bigip_dns_zone.py @@ -127,7 +127,7 @@ allow_notify_from: notify_action: description: The new DNS Express Notify Action value. returned: changed - type: string + type: str sample: consume verify_tsig: description: The new DNS Express Verify Notify TSIG value. @@ -137,7 +137,7 @@ verify_tsig: express_server: description: The new DNS Express Server value. returned: changed - type: string + type: str sample: server1 response_policy: description: The new DNS Express Response Policy value. @@ -152,7 +152,7 @@ nameservers: tsig_server_key: description: The new TSIG Server Key value. returned: changed - type: string + type: str sample: /Common/key1 ''' diff --git a/lib/ansible/modules/network/f5/bigip_firewall_address_list.py b/lib/ansible/modules/network/f5/bigip_firewall_address_list.py index ff43ffe6a8..c96a01b628 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_address_list.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_address_list.py @@ -110,7 +110,7 @@ RETURN = r''' description: description: The new description of the address list. returned: changed - type: string + type: str sample: My address list addresses: description: The new list of addresses applied to the address list. @@ -140,12 +140,12 @@ geo_locations: country: description: Country of the geo location. returned: changed - type: string + type: str sample: US region: description: Region of the geo location. returned: changed - type: string + type: str sample: California ''' diff --git a/lib/ansible/modules/network/f5/bigip_firewall_dos_profile.py b/lib/ansible/modules/network/f5/bigip_firewall_dos_profile.py index 61d51d5177..1d3d3220d5 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_dos_profile.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_dos_profile.py @@ -79,17 +79,17 @@ RETURN = r''' threshold_sensitivity: description: The new threshold sensitivity of the profile. returned: changed - type: string + type: str sample: low default_whitelist: description: The new whitelist attached to the profile. returned: changed - type: string + type: str sample: /Common/whitelist1 description: description: The description of the profile. returned: changed - type: string + type: str sample: New description ''' diff --git a/lib/ansible/modules/network/f5/bigip_firewall_dos_vector.py b/lib/ansible/modules/network/f5/bigip_firewall_dos_vector.py index 26920d794f..6a94be6aef 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_dos_vector.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_dos_vector.py @@ -312,47 +312,47 @@ blacklist_duration: attack_ceiling: description: The new Attack Ceiling EPS setting. returned: changed - type: string + type: str sample: infinite attack_floor: description: The new Attack Floor EPS setting. returned: changed - type: string + type: str sample: infinite blacklist_category: description: The new Category Name setting. returned: changed - type: string + type: str sample: /Common/cloud_provider_networks per_source_ip_detection_threshold: description: The new Per Source IP Detection Threshold EPS setting. returned: changed - type: string + type: str sample: 23 per_source_ip_mitigation_threshold: description: The new Per Source IP Mitigation Threshold EPS setting. returned: changed - type: string + type: str sample: infinite detection_threshold_percent: description: The new Detection Threshold Percent setting. returned: changed - type: string + type: str sample: infinite detection_threshold_eps: description: The new Detection Threshold EPS setting. returned: changed - type: string + type: str sample: infinite mitigation_threshold_eps: description: The new Mitigation Threshold EPS setting. returned: changed - type: string + type: str sample: infinite threshold_mode: description: The new Mitigation Threshold EPS setting. returned: changed - type: string + type: str sample: infinite simulate_auto_threshold: description: The new Simulate Auto Threshold setting. @@ -362,7 +362,7 @@ simulate_auto_threshold: state: description: The new state of the vector. returned: changed - type: string + type: str sample: mitigate ''' diff --git a/lib/ansible/modules/network/f5/bigip_firewall_global_rules.py b/lib/ansible/modules/network/f5/bigip_firewall_global_rules.py index 591f32acb9..1ae8ce4cef 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_global_rules.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_global_rules.py @@ -68,22 +68,22 @@ RETURN = r''' enforced_policy: description: The new global Enforced Policy. returned: changed - type: string + type: str sample: /Common/enforced1 service_policy: description: The new global Service Policy. returned: changed - type: string + type: str sample: /Common/service1 staged_policy: description: The new global Staged Policy. returned: changed - type: string + type: str sample: /Common/staged1 description: description: The new description. returned: changed - type: string + type: str sample: My description ''' diff --git a/lib/ansible/modules/network/f5/bigip_firewall_policy.py b/lib/ansible/modules/network/f5/bigip_firewall_policy.py index a294ccd041..62dcf7c425 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_policy.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_policy.py @@ -76,7 +76,7 @@ RETURN = r''' description: description: The new description of the policy. returned: changed - type: string + type: str sample: My firewall policy rules: description: The list of rules, in the order that they are evaluated, on the device. diff --git a/lib/ansible/modules/network/f5/bigip_firewall_port_list.py b/lib/ansible/modules/network/f5/bigip_firewall_port_list.py index 5a13eb60fe..a5cd988c2c 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_port_list.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_port_list.py @@ -146,7 +146,7 @@ RETURN = r''' description: description: The new description of the port list. returned: changed - type: string + type: str sample: My port list ports: description: The new list of ports applied to the port list. diff --git a/lib/ansible/modules/network/f5/bigip_firewall_rule.py b/lib/ansible/modules/network/f5/bigip_firewall_rule.py index cf5f0d2e4a..f2e65dcc3a 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_rule.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_rule.py @@ -289,7 +289,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_firewall_rule_list.py b/lib/ansible/modules/network/f5/bigip_firewall_rule_list.py index d41082f21d..0846ba5aa3 100644 --- a/lib/ansible/modules/network/f5/bigip_firewall_rule_list.py +++ b/lib/ansible/modules/network/f5/bigip_firewall_rule_list.py @@ -76,7 +76,7 @@ RETURN = r''' description: description: The new description of the policy. returned: changed - type: string + type: str sample: My firewall policy rules: description: The list of rules, in the order that they are evaluated, on the device. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_datacenter.py b/lib/ansible/modules/network/f5/bigip_gtm_datacenter.py index f374a569b4..7a27f18770 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_datacenter.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_datacenter.py @@ -77,12 +77,12 @@ RETURN = r''' contact: description: The contact that was set on the datacenter. returned: changed - type: string + type: str sample: admin@root.local description: description: The description that was set for the datacenter. returned: changed - type: string + type: str sample: Datacenter in NYC enabled: description: Whether the datacenter is enabled or not @@ -97,12 +97,12 @@ disabled: state: description: State of the datacenter. returned: changed - type: string + type: str sample: disabled location: description: The location that is set for the datacenter. returned: changed - type: string + type: str sample: 222 West 23rd ''' diff --git a/lib/ansible/modules/network/f5/bigip_gtm_global.py b/lib/ansible/modules/network/f5/bigip_gtm_global.py index a68706d202..ad9605526e 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_global.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_global.py @@ -67,12 +67,12 @@ synchronization: synchronization_group_name: description: The synchronization group name. returned: changed - type: string + type: str sample: my-group synchronize_zone_files: description: Whether or not the system will sync zone files. returned: changed - type: string + type: str sample: my-group ''' diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_bigip.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_bigip.py index b7aae4bbc1..20edf00a01 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_bigip.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_bigip.py @@ -154,12 +154,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: bigip ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. @@ -174,7 +174,7 @@ timeout: aggregate_dynamic_ratios: description: The new aggregate of to the monitor. returned: changed - type: string + type: str sample: sum-members ignore_down_response: description: Whether to ignore the down response or not. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py index 29898f9d73..db8cec136b 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_external.py @@ -132,12 +132,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: external ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_firepass.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_firepass.py index fe1bd9ed73..3066b5c966 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_firepass.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_firepass.py @@ -172,17 +172,17 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: firepass_gtm ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 port: description: The new port the monitor checks the resource on. returned: changed - type: string + type: str sample: 8080 interval: description: The new interval in which to run the monitor check. @@ -207,7 +207,7 @@ probe_timeout: cipher_list: description: The new value for the cipher list. returned: changed - type: string + type: str sample: +3DES:+kEDH max_load_average: description: The new value for the max load average. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_http.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_http.py index 865f2b0c14..849ea42496 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_http.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_http.py @@ -176,17 +176,17 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: http ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 port: description: The new port the monitor checks the resource on. returned: changed - type: string + type: str sample: 8080 interval: description: The new interval in which to run the monitor check. @@ -206,12 +206,12 @@ ignore_down_response: send: description: The new send string for this monitor. returned: changed - type: string + type: str sample: tcp string to send receive: description: The new receive string for this monitor. returned: changed - type: string + type: str sample: tcp string to receive probe_timeout: description: The new timeout in which the system will timeout the monitor probe. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_https.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_https.py index 648f2fedff..54affccdb0 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_https.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_https.py @@ -195,17 +195,17 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: https ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 port: description: The new port the monitor checks the resource on. returned: changed - type: string + type: str sample: 8080 interval: description: The new interval in which to run the monitor check. @@ -225,12 +225,12 @@ ignore_down_response: send: description: The new send string for this monitor. returned: changed - type: string + type: str sample: tcp string to send receive: description: The new receive string for this monitor. returned: changed - type: string + type: str sample: tcp string to receive probe_timeout: description: The new timeout in which the system will timeout the monitor probe. @@ -250,7 +250,7 @@ transparent: cipher_list: description: The new value for the cipher list. returned: changed - type: string + type: str sample: +3DES:+kEDH compatibility: description: The new SSL compatibility setting. @@ -260,12 +260,12 @@ compatibility: client_cert: description: The new client cert setting. returned: changed - type: string + type: str sample: /Common/default client_key: description: The new client key setting. returned: changed - type: string + type: str sample: /Common/default ''' diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp.py index 7ab1203cd6..f9422dc2b1 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp.py @@ -160,17 +160,17 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: tcp ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 port: description: The new port the monitor checks the resource on. returned: changed - type: string + type: str sample: 8080 interval: description: The new interval in which to run the monitor check. @@ -190,12 +190,12 @@ ignore_down_response: send: description: The new send string for this monitor. returned: changed - type: string + type: str sample: tcp string to send receive: description: The new receive string for this monitor. returned: changed - type: string + type: str sample: tcp string to receive probe_timeout: description: The new timeout in which the system will timeout the monitor probe. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp_half_open.py b/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp_half_open.py index 5275abbd4c..9884388835 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp_half_open.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_monitor_tcp_half_open.py @@ -154,12 +154,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: tcp_half_open ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_pool.py b/lib/ansible/modules/network/f5/bigip_gtm_pool.py index ad00409b6c..e8a700c043 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_pool.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_pool.py @@ -217,22 +217,22 @@ RETURN = r''' preferred_lb_method: description: New preferred load balancing method for the pool. returned: changed - type: string + type: str sample: topology alternate_lb_method: description: New alternate load balancing method for the pool. returned: changed - type: string + type: str sample: drop-packet fallback_lb_method: description: New fallback load balancing method for the pool. returned: changed - type: string + type: str sample: fewest-hops fallback_ip: description: New fallback IP used when load balacing using the C(fallback_ip) method. returned: changed - type: string + type: str sample: 10.10.10.10 monitors: description: The new list of monitors for the resource. @@ -247,11 +247,11 @@ members: server: description: The name of the server portion of the member. returned: changed - type: string + type: str virtual_server: description: The name of the virtual server portion of the member. returned: changed - type: string + type: str max_answers_returned: description: The new Maximum Answers Returned value. returned: changed diff --git a/lib/ansible/modules/network/f5/bigip_gtm_pool_member.py b/lib/ansible/modules/network/f5/bigip_gtm_pool_member.py index 42ff9f53d7..b150768206 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_pool_member.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_pool_member.py @@ -198,7 +198,7 @@ member_order: monitor: description: The new monitor assigned to the pool member. returned: changed - type: string + type: str sample: /Common/monitor1 packets_enabled: description: Whether the packets limit is enabled. @@ -218,7 +218,7 @@ ratio: description: description: The new description of the member. returned: changed - type: string + type: str sample: My description ''' diff --git a/lib/ansible/modules/network/f5/bigip_gtm_server.py b/lib/ansible/modules/network/f5/bigip_gtm_server.py index 06d3e11cf3..01868a9a88 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_server.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_server.py @@ -366,22 +366,22 @@ monitors: link_discovery: description: The new C(link_discovery) configured on the remote device. returned: changed - type: string + type: str sample: enabled virtual_server_discovery: description: The new C(virtual_server_discovery) name for the trap destination. returned: changed - type: string + type: str sample: disabled server_type: description: The new type of the server. returned: changed - type: string + type: str sample: bigip datacenter: description: The new C(datacenter) which the server is part of. returned: changed - type: string + type: str sample: datacenter01 packets_enabled: description: Whether the packets limit is enabled. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_virtual_server.py b/lib/ansible/modules/network/f5/bigip_gtm_virtual_server.py index 7af63e8095..654b9b7199 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_virtual_server.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_virtual_server.py @@ -190,12 +190,12 @@ RETURN = r''' server_name: description: The server name associated with the virtual server. returned: changed - type: string + type: str sample: /Common/my-gtm-server address: description: The new address of the resource. returned: changed - type: string + type: str sample: 1.2.3.4 port: description: The new port of the resource. @@ -230,7 +230,7 @@ virtual_server_dependencies: link: description: The new link value for the resource. returned: changed - type: string + type: str sample: /Common/my-link limits: description: The new limit configurations for the resource. diff --git a/lib/ansible/modules/network/f5/bigip_gtm_wide_ip.py b/lib/ansible/modules/network/f5/bigip_gtm_wide_ip.py index f09824d3ea..df5337a538 100644 --- a/lib/ansible/modules/network/f5/bigip_gtm_wide_ip.py +++ b/lib/ansible/modules/network/f5/bigip_gtm_wide_ip.py @@ -183,12 +183,12 @@ RETURN = r''' lb_method: description: The new load balancing method used by the wide IP. returned: changed - type: string + type: str sample: topology state: description: The new state of the wide IP. returned: changed - type: string + type: str sample: disabled irules: description: iRules set on the Wide IP. diff --git a/lib/ansible/modules/network/f5/bigip_hostname.py b/lib/ansible/modules/network/f5/bigip_hostname.py index 791b6198eb..473052b0d4 100644 --- a/lib/ansible/modules/network/f5/bigip_hostname.py +++ b/lib/ansible/modules/network/f5/bigip_hostname.py @@ -46,7 +46,7 @@ RETURN = r''' hostname: description: The new hostname of the device returned: changed - type: string + type: str sample: big-ip01.internal ''' diff --git a/lib/ansible/modules/network/f5/bigip_ike_peer.py b/lib/ansible/modules/network/f5/bigip_ike_peer.py index 06de578dda..baf8e9e34b 100644 --- a/lib/ansible/modules/network/f5/bigip_ike_peer.py +++ b/lib/ansible/modules/network/f5/bigip_ike_peer.py @@ -195,22 +195,22 @@ RETURN = r''' presented_id_type: description: The new Presented ID Type value of the resource. returned: changed - type: string + type: str sample: address verified_id_type: description: The new Verified ID Type value of the resource. returned: changed - type: string + type: str sample: address phase1_auth_method: description: The new IKE Phase 1 Credentials Authentication Method value of the resource. returned: changed - type: string + type: str sample: rsa-signature remote_address: description: The new Remote Address value of the resource. returned: changed - type: string + type: str sample: 1.2.2.1 version: description: The new list of IKE versions. @@ -220,27 +220,27 @@ version: phase1_encryption_algorithm: description: The new IKE Phase 1 Encryption Algorithm. returned: changed - type: string + type: str sample: 3des phase1_hash_algorithm: description: The new IKE Phase 1 Authentication Algorithm. returned: changed - type: string + type: str sample: sha256 phase1_perfect_forward_secrecy: description: The new IKE Phase 1 Perfect Forward Secrecy. returned: changed - type: string + type: str sample: modp1024 phase1_cert: description: The new IKE Phase 1 Certificate Credentials. returned: changed - type: string + type: str sample: /Common/cert1.crt phase1_key: description: The new IKE Phase 1 Key Credentials. returned: changed - type: string + type: str sample: /Common/cert1.key phase1_verify_peer_cert: description: The new IKE Phase 1 Key Verify Peer Certificate setting. @@ -250,12 +250,12 @@ phase1_verify_peer_cert: verified_id_value: description: The new Verified ID Value setting for the Verified ID Type. returned: changed - type: string + type: str sample: 1.2.3.1 presented_id_value: description: The new Presented ID Value setting for the Presented ID Type. returned: changed - type: string + type: str sample: 1.2.3.1 ''' diff --git a/lib/ansible/modules/network/f5/bigip_imish_config.py b/lib/ansible/modules/network/f5/bigip_imish_config.py index 103f8ab3c0..6e8d395709 100644 --- a/lib/ansible/modules/network/f5/bigip_imish_config.py +++ b/lib/ansible/modules/network/f5/bigip_imish_config.py @@ -240,7 +240,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/bigip_imish_config.2016-07-16@22:28:34 ''' diff --git a/lib/ansible/modules/network/f5/bigip_ipsec_policy.py b/lib/ansible/modules/network/f5/bigip_ipsec_policy.py index b8dce6e541..bab7998121 100644 --- a/lib/ansible/modules/network/f5/bigip_ipsec_policy.py +++ b/lib/ansible/modules/network/f5/bigip_ipsec_policy.py @@ -164,12 +164,12 @@ RETURN = r''' auth_algorithm: description: The new IKE Phase 2 Authentication Algorithm value. returned: changed - type: string + type: str sample: sha512 encrypt_algorithm: description: The new IKE Phase 2 Encryption Algorithm value. returned: changed - type: string + type: str sample: aes256 lifetime: description: The new IKE Phase 2 Lifetime value. @@ -184,37 +184,37 @@ kb_lifetime: perfect_forward_secrecy: description: The new IKE Phase 2 Perfect Forward Secrecy value. returned: changed - type: string + type: str sample: modp2048 tunnel_local_address: description: The new Tunnel Local Address value. returned: changed - type: string + type: str sample: 1.2.2.1 tunnel_remote_address: description: The new Tunnel Remote Address value. returned: changed - type: string + type: str sample: 2.1.1.2 mode: description: The new Mode value. returned: changed - type: string + type: str sample: tunnel protocol: description: The new IPsec Protocol value. returned: changed - type: string + type: str sample: ah ipcomp: description: The new IKE Phase 2 IPComp value. returned: changed - type: string + type: str sample: deflate description: description: The new description value. returned: changed - type: string + type: str sample: My policy route_domain: description: The new Route Domain value when in Tunnel mode. diff --git a/lib/ansible/modules/network/f5/bigip_irule.py b/lib/ansible/modules/network/f5/bigip_irule.py index 6f31b024f1..91e5a1f9e1 100644 --- a/lib/ansible/modules/network/f5/bigip_irule.py +++ b/lib/ansible/modules/network/f5/bigip_irule.py @@ -90,17 +90,17 @@ RETURN = r''' module: description: The module that the iRule was added to returned: changed and success - type: string + type: str sample: gtm src: description: The filename that included the iRule source returned: changed and success, when provided - type: string + type: str sample: /opt/src/irules/example1.tcl content: description: The content of the iRule that was managed returned: changed and success - type: string + type: str sample: "when LB_FAILED { set wipHost [LB::server addr] }" ''' diff --git a/lib/ansible/modules/network/f5/bigip_log_destination.py b/lib/ansible/modules/network/f5/bigip_log_destination.py index a897a567b4..b3e0eb183d 100644 --- a/lib/ansible/modules/network/f5/bigip_log_destination.py +++ b/lib/ansible/modules/network/f5/bigip_log_destination.py @@ -259,32 +259,32 @@ RETURN = r''' forward_to: description: The new Forward To value. returned: changed - type: string + type: str sample: /Common/dest1 pool: description: The new Pool value. returned: changed - type: string + type: str sample: /Common/pool1 distribution: description: The new Distribution Method value. returned: changed - type: string + type: str sample: balanced protocol: description: The new Protocol value. returned: changed - type: string + type: str sample: tcp syslog_format: description: The new Syslog format value. returned: changed - type: string + type: str sample: syslog address: description: The new Address value. returned: changed - type: string + type: str sample: 1.2.3.2 port: description: The new Port value. @@ -304,12 +304,12 @@ template_retransmit_interval: transport_profile: description: The new Transport Profile value. returned: changed - type: string + type: str sample: /Common/tcp server_ssl_profile: description: The new Server SSL Profile value. returned: changed - type: string + type: str sample: /Common/serverssl ''' diff --git a/lib/ansible/modules/network/f5/bigip_log_publisher.py b/lib/ansible/modules/network/f5/bigip_log_publisher.py index 0932eabef4..0df7aa5d8e 100644 --- a/lib/ansible/modules/network/f5/bigip_log_publisher.py +++ b/lib/ansible/modules/network/f5/bigip_log_publisher.py @@ -67,7 +67,7 @@ RETURN = r''' description: description: The new description of the resource. returned: changed - type: string + type: str sample: "Security log publisher" destinations: description: The new list of destinations for the resource. diff --git a/lib/ansible/modules/network/f5/bigip_management_route.py b/lib/ansible/modules/network/f5/bigip_management_route.py index 7ff0da826f..51e81ca048 100644 --- a/lib/ansible/modules/network/f5/bigip_management_route.py +++ b/lib/ansible/modules/network/f5/bigip_management_route.py @@ -76,17 +76,17 @@ RETURN = r''' description: description: The new description of the management route. returned: changed - type: string + type: str sample: Route to TACACS gateway: description: The new gateway of the management route. returned: changed - type: string + type: str sample: 10.10.10.10 network: description: The new network to use for the management route. returned: changed - type: string + type: str sample: default ''' diff --git a/lib/ansible/modules/network/f5/bigip_monitor_dns.py b/lib/ansible/modules/network/f5/bigip_monitor_dns.py index 983820879b..7a6960a824 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_dns.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_dns.py @@ -235,12 +235,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: http ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. @@ -265,12 +265,12 @@ adaptive: accept_rcode: description: RCODE required in the response for an up status. returned: changed - type: string + type: str sample: no-error allowed_divergence_type: description: Type of divergence used for adaptive response time monitoring. returned: changed - type: string + type: str sample: absolute allowed_divergence_value: description: @@ -297,14 +297,14 @@ sampling_timespan: answer_section_contains: description: Type of DNS query that the monitor sends. returned: changed - type: string + type: str sample: query-type manual_resume: description: - Whether the system automatically changes the status of a resource to enabled at the next successful monitor check. returned: changed - type: string + type: str sample: query-type up_interval: description: Interval for the system to use to perform the health check when a resource is up. @@ -314,17 +314,17 @@ up_interval: query_name: description: Query name for the monitor to use in a DNS query. returned: changed - type: string + type: str sample: foo query_type: description: Type of DNS query that the monitor sends. Either C(a) or C(aaaa). returned: changed - type: string + type: str sample: aaaa receive: description: IP address that the monitor uses from the resource record sections of the DNS response. returned: changed - type: string + type: str sample: 2.3.2.4 reverse: description: Whether the monitor operates in reverse mode. @@ -336,7 +336,7 @@ port: - Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. returned: changed - type: string + type: str sample: 80 transparent: description: Whether the monitor operates in transparent mode. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_external.py b/lib/ansible/modules/network/f5/bigip_monitor_external.py index ab6dca736b..3427d53294 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_external.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_external.py @@ -138,7 +138,7 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: external description: description: The description of the monitor. @@ -148,7 +148,7 @@ description: ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_gateway_icmp.py b/lib/ansible/modules/network/f5/bigip_monitor_gateway_icmp.py index babd6e7d07..1deb23975b 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_gateway_icmp.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_gateway_icmp.py @@ -174,12 +174,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: gateway-icmp ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. @@ -204,7 +204,7 @@ adaptive: allowed_divergence_type: description: Type of divergence used for adaptive response time monitoring. returned: changed - type: string + type: str sample: absolute allowed_divergence_value: description: @@ -238,7 +238,7 @@ port: - Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. returned: changed - type: string + type: str sample: 80 transparent: description: Whether the monitor operates in transparent mode. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_http.py b/lib/ansible/modules/network/f5/bigip_monitor_http.py index ecb7eefcaf..6161523400 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_http.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_http.py @@ -157,7 +157,7 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: http description: description: The description of the monitor. @@ -167,7 +167,7 @@ description: ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_https.py b/lib/ansible/modules/network/f5/bigip_monitor_https.py index a6d1a5443e..ec4c72512b 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_https.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_https.py @@ -149,12 +149,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: https ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_ldap.py b/lib/ansible/modules/network/f5/bigip_monitor_ldap.py index a505faa0a6..87f4758892 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_ldap.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_ldap.py @@ -162,7 +162,7 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: ldap description: description: The description of the monitor. @@ -172,7 +172,7 @@ description: ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. @@ -192,7 +192,7 @@ time_until_up: security: description: The new Security setting of the resource. returned: changed - type: string + type: str sample: ssl debug: description: The new Debug setting of the resource. @@ -217,12 +217,12 @@ manual_resume: filter: description: The new LDAP Filter setting of the resource. returned: changed - type: string + type: str sample: filter1 base: description: The new LDAP Base setting of the resource. returned: changed - type: string + type: str sample: base ''' diff --git a/lib/ansible/modules/network/f5/bigip_monitor_snmp_dca.py b/lib/ansible/modules/network/f5/bigip_monitor_snmp_dca.py index 3c8c66d088..2d13b4343e 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_snmp_dca.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_snmp_dca.py @@ -158,7 +158,7 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: snmp_dca description: description: The description of the monitor. @@ -183,17 +183,17 @@ time_until_up: community: description: The new community for the monitor. returned: changed - type: string + type: str sample: foobar version: description: The new new SNMP version to be used by the monitor. returned: changed - type: string + type: str sample: v2c agent_type: description: The new agent type to be used by the monitor. returned: changed - type: string + type: str sample: UCD cpu_coefficient: description: The new CPU coefficient. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_tcp.py b/lib/ansible/modules/network/f5/bigip_monitor_tcp.py index ba987f0b23..94060a4d5d 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_tcp.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_tcp.py @@ -125,12 +125,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: tcp send: description: The new send string for this monitor. returned: changed - type: string + type: str sample: tcp string to send description: description: The description of the monitor. @@ -140,17 +140,17 @@ description: receive: description: The new receive string for this monitor. returned: changed - type: string + type: str sample: tcp string to receive ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 port: description: The new port of IP/port definition. returned: changed - type: string + type: str sample: admin@root.local interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py b/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py index fd37db9f23..65e7a33259 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_tcp_echo.py @@ -109,12 +109,12 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: tcp ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 description: description: The description of the monitor. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_tcp_half_open.py b/lib/ansible/modules/network/f5/bigip_monitor_tcp_half_open.py index 5ba8b669b8..822bc5301d 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_tcp_half_open.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_tcp_half_open.py @@ -128,7 +128,7 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: tcp description: description: The description of the monitor. @@ -138,7 +138,7 @@ description: ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_monitor_udp.py b/lib/ansible/modules/network/f5/bigip_monitor_udp.py index 6f445e54a8..ce77df8217 100644 --- a/lib/ansible/modules/network/f5/bigip_monitor_udp.py +++ b/lib/ansible/modules/network/f5/bigip_monitor_udp.py @@ -128,7 +128,7 @@ RETURN = r''' parent: description: New parent template of the monitor. returned: changed - type: string + type: str sample: http description: description: The description of the monitor. @@ -138,7 +138,7 @@ description: ip: description: The new IP of IP/port definition. returned: changed - type: string + type: str sample: 10.12.13.14 interval: description: The new interval in which to run the monitor check. diff --git a/lib/ansible/modules/network/f5/bigip_node.py b/lib/ansible/modules/network/f5/bigip_node.py index c0e8d10fcf..2b0d04ec8e 100644 --- a/lib/ansible/modules/network/f5/bigip_node.py +++ b/lib/ansible/modules/network/f5/bigip_node.py @@ -255,7 +255,7 @@ monitor_type: description: - Changed value for the monitor_type of the node. returned: changed and success - type: string + type: str sample: m_of_n quorum: description: @@ -273,19 +273,19 @@ description: description: - Changed value for the description of the node. returned: changed and success - type: string + type: str sample: E-Commerce webserver in ORD session: description: - Changed value for the internal session of the node. returned: changed and success - type: string + type: str sample: user-disabled state: description: - Changed value for the internal state of the node. returned: changed and success - type: string + type: str sample: m_of_n ''' diff --git a/lib/ansible/modules/network/f5/bigip_partition.py b/lib/ansible/modules/network/f5/bigip_partition.py index ad9c5c26e4..bf11f849ea 100644 --- a/lib/ansible/modules/network/f5/bigip_partition.py +++ b/lib/ansible/modules/network/f5/bigip_partition.py @@ -107,7 +107,7 @@ route_domain: description: description: The description of the partition. returned: changed and success - type: string + type: str sample: Example partition ''' diff --git a/lib/ansible/modules/network/f5/bigip_policy.py b/lib/ansible/modules/network/f5/bigip_policy.py index 016c49cbc6..61ae7abef7 100644 --- a/lib/ansible/modules/network/f5/bigip_policy.py +++ b/lib/ansible/modules/network/f5/bigip_policy.py @@ -179,7 +179,7 @@ description: - The new description of the policy. - This value is only returned for BIG-IP devices >= 12.1.0. returned: changed and success - type: string + type: str sample: This is my description rules: description: List of the rules, and their order, applied to the policy. diff --git a/lib/ansible/modules/network/f5/bigip_policy_rule.py b/lib/ansible/modules/network/f5/bigip_policy_rule.py index 09528dc616..5080961d81 100644 --- a/lib/ansible/modules/network/f5/bigip_policy_rule.py +++ b/lib/ansible/modules/network/f5/bigip_policy_rule.py @@ -199,12 +199,12 @@ actions: type: description: The action type returned: changed - type: string + type: str sample: forward pool: description: Pool for forward to returned: changed - type: string + type: str sample: foo-pool sample: hash/dictionary of values conditions: @@ -215,7 +215,7 @@ conditions: type: description: The condition type. returned: changed - type: string + type: str sample: http_uri path_begins_with_any: description: List of strings that the URI begins with. @@ -226,7 +226,7 @@ conditions: description: description: The new description of the rule. returned: changed - type: string + type: str sample: My rule ''' diff --git a/lib/ansible/modules/network/f5/bigip_pool.py b/lib/ansible/modules/network/f5/bigip_pool.py index 6c3a4bfbb2..84dd4024a1 100644 --- a/lib/ansible/modules/network/f5/bigip_pool.py +++ b/lib/ansible/modules/network/f5/bigip_pool.py @@ -293,7 +293,7 @@ RETURN = r''' monitor_type: description: The contact that was set on the datacenter. returned: changed - type: string + type: str sample: admin@root.local quorum: description: The quorum that was set on the pool. @@ -308,17 +308,17 @@ monitors: service_down_action: description: Service down action that is set on the pool. returned: changed - type: string + type: str sample: reset description: description: Description set on the pool. returned: changed - type: string + type: str sample: Pool of web servers lb_method: description: The LB method set for the pool. returned: changed - type: string + type: str sample: round-robin slow_ramp_time: description: The new value that is set for the slow ramp-up time. diff --git a/lib/ansible/modules/network/f5/bigip_pool_member.py b/lib/ansible/modules/network/f5/bigip_pool_member.py index 4ac4678828..0ec30f4be6 100644 --- a/lib/ansible/modules/network/f5/bigip_pool_member.py +++ b/lib/ansible/modules/network/f5/bigip_pool_member.py @@ -268,7 +268,7 @@ connection_limit: description: description: The new description of pool member. returned: changed - type: string + type: str sample: My pool member ratio: description: The new pool member ratio weight. @@ -288,12 +288,12 @@ fqdn_auto_populate: fqdn: description: The FQDN of the pool member. returned: changed - type: string + type: str sample: foo.bar.com address: description: The address of the pool member. returned: changed - type: string + type: str sample: 1.2.3.4 monitors: description: The new list of monitors for the resource. diff --git a/lib/ansible/modules/network/f5/bigip_profile_analytics.py b/lib/ansible/modules/network/f5/bigip_profile_analytics.py index cd4312d278..a7e6fb843d 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_analytics.py +++ b/lib/ansible/modules/network/f5/bigip_profile_analytics.py @@ -127,7 +127,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_profile_client_ssl.py b/lib/ansible/modules/network/f5/bigip_profile_client_ssl.py index 4813f645b7..7025db3fb5 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_client_ssl.py +++ b/lib/ansible/modules/network/f5/bigip_profile_client_ssl.py @@ -277,7 +277,7 @@ RETURN = r''' ciphers: description: The ciphers applied to the profile. returned: changed - type: string + type: str sample: "!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA" options: description: The list of options for SSL processing. @@ -287,7 +287,7 @@ options: secure_renegotation: description: The method of secure SSL renegotiation. returned: changed - type: string + type: str sample: request allow_non_ssl: description: Acceptance of non-SSL connections. diff --git a/lib/ansible/modules/network/f5/bigip_profile_dns.py b/lib/ansible/modules/network/f5/bigip_profile_dns.py index 041456b03c..6ea03c7c5f 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_dns.py +++ b/lib/ansible/modules/network/f5/bigip_profile_dns.py @@ -210,12 +210,12 @@ enable_cache: cache_name: description: Name of the cache used by DNS. returned: changed - type: string + type: str sample: /Common/cache1 unhandled_query_action: description: What to do with unhandled queries returned: changed - type: string + type: str sample: allow ''' diff --git a/lib/ansible/modules/network/f5/bigip_profile_fastl4.py b/lib/ansible/modules/network/f5/bigip_profile_fastl4.py index e7cfa59e57..c0ca335268 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_fastl4.py +++ b/lib/ansible/modules/network/f5/bigip_profile_fastl4.py @@ -289,12 +289,12 @@ RETURN = r''' client_timeout: description: The new client timeout value of the resource. returned: changed - type: string + type: str sample: true description: description: The new description. returned: changed - type: string + type: str sample: My description explicit_flow_migration: description: The new flow migration setting. @@ -304,27 +304,27 @@ explicit_flow_migration: idle_timeout: description: The new idle timeout setting. returned: changed - type: string + type: str sample: 123 ip_df_mode: description: The new Don't Fragment Flag (DF) setting. returned: changed - type: string + type: str sample: clear ip_tos_to_client: description: The new IP ToS to Client setting. returned: changed - type: string + type: str sample: 100 ip_tos_to_server: description: The new IP ToS to Server setting. returned: changed - type: string + type: str sample: 100 ip_ttl_mode: description: The new Time To Live (TTL) setting. returned: changed - type: string + type: str sample: proxy ip_ttl_v4: description: The new Time To Live (TTL) v4 setting. @@ -349,12 +349,12 @@ late_binding: link_qos_to_client: description: The new Link QoS to Client setting. returned: changed - type: string + type: str sample: pass-through link_qos_to_server: description: The new Link QoS to Server setting. returned: changed - type: string + type: str sample: 123 loose_close: description: The new Loose Close setting. @@ -414,7 +414,7 @@ syn_cookie_mss: tcp_close_timeout: description: The new TCP Close Timeout setting. returned: changed - type: string + type: str sample: 100 tcp_generate_isn: description: The new Generate Initial Sequence Number setting. @@ -439,17 +439,17 @@ tcp_time_wait_timeout: tcp_timestamp_mode: description: The new TCP Timestamp Mode setting. returned: changed - type: string + type: str sample: rewrite tcp_wscale_mode: description: The new TCP Window Scale Mode setting. returned: changed - type: string + type: str sample: strip timeout_recovery: description: The new Timeout Recovery setting. returned: changed - type: string + type: str sample: fallback ''' diff --git a/lib/ansible/modules/network/f5/bigip_profile_http.py b/lib/ansible/modules/network/f5/bigip_profile_http.py index e6c2ffa761..212e7ffac6 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_http.py +++ b/lib/ansible/modules/network/f5/bigip_profile_http.py @@ -197,12 +197,12 @@ RETURN = r''' description: description: Description of the profile. returned: changed - type: string + type: str sample: My profile proxy_type: description: Specify proxy mode of the profile. returned: changed - type: string + type: str sample: explicit insert_xforwarded_for: description: Insert X-Forwarded-For-Header. @@ -212,7 +212,7 @@ insert_xforwarded_for: redirect_rewrite: description: Rewrite URI that are part of 3xx responses. returned: changed - type: string + type: str sample: all encrypt_cookies: description: Cookie names to encrypt. @@ -222,7 +222,7 @@ encrypt_cookies: dns_resolver: description: Configured dns resolver. returned: changed - type: string + type: str sample: '/Common/FooBar' ''' diff --git a/lib/ansible/modules/network/f5/bigip_profile_http2.py b/lib/ansible/modules/network/f5/bigip_profile_http2.py index 6773f0e3a7..9b2067a039 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_http2.py +++ b/lib/ansible/modules/network/f5/bigip_profile_http2.py @@ -148,12 +148,12 @@ RETURN = r''' description: description: Description of the profile. returned: changed - type: string + type: str sample: My profile insert_header_name: description: Specifies the name of the HTTP2 header returned: changed - type: string + type: str sample: X-HTTP2 streams: description: The number of outstanding concurrent requests allowed on a single HTTP/2 connection diff --git a/lib/ansible/modules/network/f5/bigip_profile_http_compression.py b/lib/ansible/modules/network/f5/bigip_profile_http_compression.py index 91ab7cb8af..6ba2bcd3db 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_http_compression.py +++ b/lib/ansible/modules/network/f5/bigip_profile_http_compression.py @@ -118,7 +118,7 @@ RETURN = r''' description: description: The new description of the resource. returned: changed - type: string + type: str sample: My custom profile buffer_size: description: The new buffer size of the profile. diff --git a/lib/ansible/modules/network/f5/bigip_profile_oneconnect.py b/lib/ansible/modules/network/f5/bigip_profile_oneconnect.py index a8a2937785..2a97cc3628 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_oneconnect.py +++ b/lib/ansible/modules/network/f5/bigip_profile_oneconnect.py @@ -137,12 +137,12 @@ RETURN = r''' source_mask: description: Value that the system applies to the source address to determine its eligibility for reuse. returned: changed - type: string + type: str sample: 255.255.255.255 description: description: Description of the profile. returned: changed - type: string + type: str sample: My profile maximum_size: description: Maximum number of connections that the system holds in the connection reuse pool. @@ -162,12 +162,12 @@ maximum_reuse: idle_timeout_override: description: The new idle timeout override. returned: changed - type: string + type: str sample: disabled limit_type: description: New limit type of the profile. returned: changed - type: string + type: str sample: idle share_pools: description: Share connections among similar virtual servers. diff --git a/lib/ansible/modules/network/f5/bigip_profile_persistence_cookie.py b/lib/ansible/modules/network/f5/bigip_profile_persistence_cookie.py index d9d358fb1e..f46ed20f7e 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_persistence_cookie.py +++ b/lib/ansible/modules/network/f5/bigip_profile_persistence_cookie.py @@ -154,22 +154,22 @@ RETURN = r''' cookie_name: description: The new Cookie Name value. returned: changed - type: string + type: str sample: cookie1 cookie_method: description: The new Cookie Method. returned: changed - type: string + type: str sample: insert parent: description: The parent profile. returned: changed - type: string + type: str sample: /Common/cookie cookie_encryption: description: The new Cookie Encryption type. returned: changed - type: string + type: str sample: preferred match_across_pools: description: The new Match Across Pools value. @@ -209,7 +209,7 @@ http_only: description: description: The new description. returned: changed - type: string + type: str sample: My description secure: description: The new Secure Cookie value. diff --git a/lib/ansible/modules/network/f5/bigip_profile_persistence_src_addr.py b/lib/ansible/modules/network/f5/bigip_profile_persistence_src_addr.py index afaf0fbcea..711fbd250e 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_persistence_src_addr.py +++ b/lib/ansible/modules/network/f5/bigip_profile_persistence_src_addr.py @@ -117,7 +117,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_profile_server_ssl.py b/lib/ansible/modules/network/f5/bigip_profile_server_ssl.py index e9a9632931..6782282bab 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_server_ssl.py +++ b/lib/ansible/modules/network/f5/bigip_profile_server_ssl.py @@ -132,12 +132,12 @@ RETURN = r''' ciphers: description: The ciphers applied to the profile. returned: changed - type: string + type: str sample: "!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA" secure_renegotation: description: The method of secure SSL renegotiation. returned: changed - type: string + type: str sample: request ''' diff --git a/lib/ansible/modules/network/f5/bigip_profile_tcp.py b/lib/ansible/modules/network/f5/bigip_profile_tcp.py index f74eff52b2..1ecd9dd59b 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_tcp.py +++ b/lib/ansible/modules/network/f5/bigip_profile_tcp.py @@ -89,7 +89,7 @@ RETURN = r''' parent: description: The new parent of the resource. returned: changed - type: string + type: str sample: f5-tcp-optimized idle_timeout: description: The new idle timeout of the resource. diff --git a/lib/ansible/modules/network/f5/bigip_profile_udp.py b/lib/ansible/modules/network/f5/bigip_profile_udp.py index 77cca538c9..b524788552 100644 --- a/lib/ansible/modules/network/f5/bigip_profile_udp.py +++ b/lib/ansible/modules/network/f5/bigip_profile_udp.py @@ -86,7 +86,7 @@ RETURN = r''' parent: description: The new parent of the resource. returned: changed - type: string + type: str sample: udp idle_timeout: description: The new idle timeout of the resource. diff --git a/lib/ansible/modules/network/f5/bigip_provision.py b/lib/ansible/modules/network/f5/bigip_provision.py index 554791ad55..dc9c910009 100644 --- a/lib/ansible/modules/network/f5/bigip_provision.py +++ b/lib/ansible/modules/network/f5/bigip_provision.py @@ -99,7 +99,7 @@ RETURN = r''' level: description: The new provisioning level of the module. returned: changed - type: string + type: str sample: minimum ''' diff --git a/lib/ansible/modules/network/f5/bigip_remote_role.py b/lib/ansible/modules/network/f5/bigip_remote_role.py index 5ccb52ea3d..d70076cd27 100644 --- a/lib/ansible/modules/network/f5/bigip_remote_role.py +++ b/lib/ansible/modules/network/f5/bigip_remote_role.py @@ -114,12 +114,12 @@ RETURN = r''' attribute_string: description: The new attribute string of the resource. returned: changed - type: string + type: str sample: "memberOf=cn=ldap_group,cn=ldap.group,ou=ldap" terminal_access: description: The terminal setting of the remote role. returned: changed - type: string + type: str sample: tmsh line_order: description: Order of the remote role for LDAP and Active Directory servers. @@ -129,12 +129,12 @@ line_order: assigned_role: description: System role that this remote role is associated with. returned: changed - type: string + type: str sample: administrator partition_access: description: Partition that the role has access to. returned: changed - type: string + type: str sample: all remote_access: description: Whether remote access is allowed or not. diff --git a/lib/ansible/modules/network/f5/bigip_remote_syslog.py b/lib/ansible/modules/network/f5/bigip_remote_syslog.py index 45f4077ec0..b92145f31b 100644 --- a/lib/ansible/modules/network/f5/bigip_remote_syslog.py +++ b/lib/ansible/modules/network/f5/bigip_remote_syslog.py @@ -89,7 +89,7 @@ remote_port: local_ip: description: The new local IP of the remote syslog server returned: changed - type: string + type: str sample: 10.10.10.10 ''' diff --git a/lib/ansible/modules/network/f5/bigip_routedomain.py b/lib/ansible/modules/network/f5/bigip_routedomain.py index 25a923dc11..28190e1f65 100644 --- a/lib/ansible/modules/network/f5/bigip_routedomain.py +++ b/lib/ansible/modules/network/f5/bigip_routedomain.py @@ -132,12 +132,12 @@ id: description: description: The description of the route domain. returned: changed - type: string + type: str sample: route domain foo strict: description: The new strict isolation setting. returned: changed - type: string + type: str sample: enabled parent: description: The new parent route domain. @@ -157,7 +157,7 @@ routing_protocol: bwc_policy: description: The new bandwidth controller. returned: changed - type: string + type: str sample: /Common/foo connection_limit: description: The new connection limit for the route domain. @@ -167,17 +167,17 @@ connection_limit: flow_eviction_policy: description: The new eviction policy to use with this route domain. returned: changed - type: string + type: str sample: /Common/default-eviction-policy service_policy: description: The new service policy to use with this route domain. returned: changed - type: string + type: str sample: /Common-my-service-policy fw_enforced_policy: description: Specfies AFM policy to be attached to route domain. returned: changed - type: string + type: str sample: /Common/afm-blocking-policy ''' diff --git a/lib/ansible/modules/network/f5/bigip_selfip.py b/lib/ansible/modules/network/f5/bigip_selfip.py index 0f12e6e162..ab3f916869 100644 --- a/lib/ansible/modules/network/f5/bigip_selfip.py +++ b/lib/ansible/modules/network/f5/bigip_selfip.py @@ -193,27 +193,27 @@ allow_service: address: description: The address for the Self IP returned: changed - type: string + type: str sample: 192.0.2.10 name: description: The name of the Self IP returned: created - type: string + type: str sample: self1 netmask: description: The netmask of the Self IP returned: changed - type: string + type: str sample: 255.255.255.0 traffic_group: description: The traffic group that the Self IP is a member of returned: changed - type: string + type: str sample: traffic-group-local-only vlan: description: The VLAN set on the Self IP returned: changed - type: string + type: str sample: vlan1 ''' diff --git a/lib/ansible/modules/network/f5/bigip_service_policy.py b/lib/ansible/modules/network/f5/bigip_service_policy.py index 6e46087c97..565d247172 100644 --- a/lib/ansible/modules/network/f5/bigip_service_policy.py +++ b/lib/ansible/modules/network/f5/bigip_service_policy.py @@ -73,17 +73,17 @@ RETURN = r''' timer_policy: description: The new timer policy attached to the resource. returned: changed - type: string + type: str sample: /Common/timer1 port_misuse_policy: description: The new port misuse policy attached to the resource. returned: changed - type: string + type: str sample: /Common/misuse1 description: description: New description of the resource. returned: changed - type: string + type: str sample: My service policy description ''' diff --git a/lib/ansible/modules/network/f5/bigip_smtp.py b/lib/ansible/modules/network/f5/bigip_smtp.py index a54caf3c91..9b70dccb6c 100644 --- a/lib/ansible/modules/network/f5/bigip_smtp.py +++ b/lib/ansible/modules/network/f5/bigip_smtp.py @@ -117,7 +117,7 @@ RETURN = r''' smtp_server: description: The new C(smtp_server) value of the SMTP configuration. returned: changed - type: string + type: str sample: mail.mydomain.com smtp_server_port: description: The new C(smtp_server_port) value of the SMTP configuration. @@ -127,17 +127,17 @@ smtp_server_port: local_host_name: description: The new C(local_host_name) value of the SMTP configuration. returned: changed - type: string + type: str sample: smtp.mydomain.com from_address: description: The new C(from_address) value of the SMTP configuration. returned: changed - type: string + type: str sample: no-reply@mydomain.com encryption: description: The new C(encryption) value of the SMTP configuration. returned: changed - type: string + type: str sample: tls authentication: description: Whether the authentication parameters are active or not. diff --git a/lib/ansible/modules/network/f5/bigip_snmp.py b/lib/ansible/modules/network/f5/bigip_snmp.py index e16385b437..6f1283522a 100644 --- a/lib/ansible/modules/network/f5/bigip_snmp.py +++ b/lib/ansible/modules/network/f5/bigip_snmp.py @@ -91,27 +91,27 @@ RETURN = r''' agent_status_traps: description: Value that the agent status traps was set to. returned: changed - type: string + type: str sample: enabled agent_authentication_traps: description: Value that the authentication status traps was set to. returned: changed - type: string + type: str sample: enabled device_warning_traps: description: Value that the warning status traps was set to. returned: changed - type: string + type: str sample: enabled contact: description: The new value for the person who administers SNMP on the device. returned: changed - type: string + type: str sample: Joe User location: description: The new value for the system's physical location. returned: changed - type: string + type: str sample: US West 1a allowed_addresses: description: The new allowed addresses for SNMP client connections. diff --git a/lib/ansible/modules/network/f5/bigip_snmp_community.py b/lib/ansible/modules/network/f5/bigip_snmp_community.py index e883236260..58045996a7 100644 --- a/lib/ansible/modules/network/f5/bigip_snmp_community.py +++ b/lib/ansible/modules/network/f5/bigip_snmp_community.py @@ -197,52 +197,52 @@ RETURN = r''' community: description: The new community value. returned: changed - type: string + type: str sample: community1 oid: description: The new OID value. returned: changed - type: string + type: str sample: .1 ip_version: description: The new IP version value. returned: changed - type: string + type: str sample: .1 snmp_auth_protocol: description: The new SNMP auth protocol. returned: changed - type: string + type: str sample: sha snmp_privacy_protocol: description: The new SNMP privacy protocol. returned: changed - type: string + type: str sample: aes access: description: The new access level for the MIB. returned: changed - type: string + type: str sample: ro source: description: The new source address to access the MIB. returned: changed - type: string + type: str sample: 1.1.1.1 snmp_username: description: The new SNMP username. returned: changed - type: string + type: str sample: user1 snmp_auth_password: description: The new password of the given snmp_username. returned: changed - type: string + type: str sample: secret1 snmp_privacy_password: description: The new password of the given snmp_username. returned: changed - type: string + type: str sample: secret2 ''' diff --git a/lib/ansible/modules/network/f5/bigip_snmp_trap.py b/lib/ansible/modules/network/f5/bigip_snmp_trap.py index b7bad44a7a..f20fd760a8 100644 --- a/lib/ansible/modules/network/f5/bigip_snmp_trap.py +++ b/lib/ansible/modules/network/f5/bigip_snmp_trap.py @@ -110,7 +110,7 @@ RETURN = r''' snmp_version: description: The new C(snmp_version) configured on the remote device. returned: changed and success - type: string + type: str sample: 2c community: description: The new C(community) name for the trap destination. @@ -120,17 +120,17 @@ community: destination: description: The new address for the trap destination in either IP or hostname form. returned: changed and success - type: string + type: str sample: 1.2.3.4 port: description: The new C(port) of the trap destination. returned: changed and success - type: string + type: str sample: 900 network: description: The new name of the network the SNMP trap is on. returned: changed and success - type: string + type: str sample: management ''' diff --git a/lib/ansible/modules/network/f5/bigip_software_image.py b/lib/ansible/modules/network/f5/bigip_software_image.py index 8ecd2a4228..43edd4e7d5 100644 --- a/lib/ansible/modules/network/f5/bigip_software_image.py +++ b/lib/ansible/modules/network/f5/bigip_software_image.py @@ -82,22 +82,22 @@ RETURN = r''' image_type: description: Whether the image is a release or hotfix image returned: changed - type: string + type: str sample: release version: description: Version of the software contained in the image. returned: changed - type: string + type: str sample: 13.1.0.8 build: description: Build version of the software contained in the image. returned: changed - type: string + type: str sample: 0.0.3 checksum: description: MD5 checksum of the ISO. returned: changed - type: string + type: str sample: 8cdbd094195fab4b2b47ff4285577b70 file_size: description: Size of the uploaded image in MB. diff --git a/lib/ansible/modules/network/f5/bigip_software_update.py b/lib/ansible/modules/network/f5/bigip_software_update.py index 7982560505..4294887130 100644 --- a/lib/ansible/modules/network/f5/bigip_software_update.py +++ b/lib/ansible/modules/network/f5/bigip_software_update.py @@ -78,7 +78,7 @@ auto_phone_home: frequency: description: Frequency of auto update checks returned: changed - type: string + type: str sample: weekly ''' diff --git a/lib/ansible/modules/network/f5/bigip_ssl_certificate.py b/lib/ansible/modules/network/f5/bigip_ssl_certificate.py index 91c91fdf17..f8fde60318 100644 --- a/lib/ansible/modules/network/f5/bigip_ssl_certificate.py +++ b/lib/ansible/modules/network/f5/bigip_ssl_certificate.py @@ -103,23 +103,23 @@ RETURN = r''' cert_name: description: The name of the certificate that the user provided returned: created - type: string + type: str sample: cert1 filename: description: - The name of the SSL certificate. returned: created - type: string + type: str sample: cert1.crt checksum: description: SHA1 checksum of the cert that was provided. returned: changed and created - type: string + type: str sample: f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0 source_path: description: Path on BIG-IP where the source of the certificate is stored. returned: created - type: string + type: str sample: /var/config/rest/downloads/cert1.crt ''' diff --git a/lib/ansible/modules/network/f5/bigip_ssl_key.py b/lib/ansible/modules/network/f5/bigip_ssl_key.py index fa0a7d2bcb..add7cbc81a 100644 --- a/lib/ansible/modules/network/f5/bigip_ssl_key.py +++ b/lib/ansible/modules/network/f5/bigip_ssl_key.py @@ -93,17 +93,17 @@ key_filename: C(cert_filename) will be similar to each other, however the C(key_filename) will have a C(.key) extension. returned: created - type: string + type: str sample: cert1.key key_checksum: description: SHA1 checksum of the key that was provided. returned: changed and created - type: string + type: str sample: cf23df2207d99a74fbe169e3eba035e633b65d94 key_source_path: description: Path on BIG-IP where the source of the key is stored returned: created - type: string + type: str sample: /var/config/rest/downloads/cert1.key ''' diff --git a/lib/ansible/modules/network/f5/bigip_ssl_ocsp.py b/lib/ansible/modules/network/f5/bigip_ssl_ocsp.py index cd5ff7fd20..2bad55b7d9 100644 --- a/lib/ansible/modules/network/f5/bigip_ssl_ocsp.py +++ b/lib/ansible/modules/network/f5/bigip_ssl_ocsp.py @@ -145,7 +145,7 @@ cache_error_timeout: cache_timeout: description: The new Response Caching Timeout value. returned: changed - type: string + type: str sample: indefinite clock_skew: description: The new Response Validation Clock Skew value. @@ -160,37 +160,37 @@ connections_limit: dns_resolver: description: The new DNS Resolver value. returned: changed - type: string + type: str sample: /Common/resolver1 route_domain: description: The new Route Domain value. returned: changed - type: string + type: str sample: /Common/0 hash_algorithm: description: The new Request Signing Hash Algorithm value. returned: changed - type: string + type: str sample: sha256 certificate: description: The new Request Signing Certificate value. returned: changed - type: string + type: str sample: /Common/cert1 key: description: The new Request Signing Key value. returned: changed - type: string + type: str sample: /Common/key1 proxy_server_pool: description: The new Proxy Server Pool value. returned: changed - type: string + type: str sample: /Common/pool1 responder_url: description: The new Connection Responder URL value. returned: changed - type: string + type: str sample: "http://responder.site.com" status_age: description: The new Response Validation Status Age value. diff --git a/lib/ansible/modules/network/f5/bigip_static_route.py b/lib/ansible/modules/network/f5/bigip_static_route.py index b5702cdeed..56c2c11c43 100644 --- a/lib/ansible/modules/network/f5/bigip_static_route.py +++ b/lib/ansible/modules/network/f5/bigip_static_route.py @@ -104,17 +104,17 @@ RETURN = r''' vlan: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true gateway_address: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true destination: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true route_domain: description: Route domain of the static route. @@ -124,27 +124,27 @@ route_domain: netmask: description: Netmask of the destination. returned: changed - type: string + type: str sample: 255.255.255.255 pool: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true partition: description: The partition that the static route was created on. returned: changed - type: string + type: str sample: Common description: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true reject: description: Whether the banner is enabled or not. returned: changed - type: string + type: str sample: true ''' diff --git a/lib/ansible/modules/network/f5/bigip_sys_daemon_log_tmm.py b/lib/ansible/modules/network/f5/bigip_sys_daemon_log_tmm.py index e2130c0d0b..114227dcc8 100644 --- a/lib/ansible/modules/network/f5/bigip_sys_daemon_log_tmm.py +++ b/lib/ansible/modules/network/f5/bigip_sys_daemon_log_tmm.py @@ -149,52 +149,52 @@ RETURN = r''' arp_log_level: description: Lowest level of ARP messages from the tmm daemon to log. returned: changed - type: string + type: str sample: error http_compression_log_level: description: Lowest level of HTTP compression messages from the tmm daemon to log. returned: changed - type: string + type: str sample: debug http_log_level: description: Lowest level of HTTP messages from the tmm daemon to log. returned: changed - type: string + type: str sample: notice ip_log_level: description: Lowest level of IP address messages from the tmm daemon to log. returned: changed - type: string + type: str sample: warning irule_log_level: description: Lowest level of iRule messages from the tmm daemon to log. returned: changed - type: string + type: str sample: error layer4_log_level: description: Lowest level of Layer 4 messages from the tmm daemon to log. returned: changed - type: string + type: str sample: notice net_log_level: description: Lowest level of network messages from the tmm daemon to log. returned: changed - type: string + type: str sample: critical os_log_level: description: Lowest level of operating system messages from the tmm daemon to log. returned: changed - type: string + type: str sample: critical pva_log_level: description: Lowest level of PVA messages from the tmm daemon to log. returned: changed - type: string + type: str sample: debug ssl_log_level: description: Lowest level of SSL messages from the tmm daemon to log. returned: changed - type: string + type: str sample: critical ''' diff --git a/lib/ansible/modules/network/f5/bigip_sys_db.py b/lib/ansible/modules/network/f5/bigip_sys_db.py index 82edaf7a11..28ee149222 100644 --- a/lib/ansible/modules/network/f5/bigip_sys_db.py +++ b/lib/ansible/modules/network/f5/bigip_sys_db.py @@ -81,17 +81,17 @@ RETURN = r''' name: description: The key in the system database that was specified returned: changed and success - type: string + type: str sample: setup.run default_value: description: The default value of the key returned: changed and success - type: string + type: str sample: true value: description: The value that you set the key to returned: changed and success - type: string + type: str sample: false ''' diff --git a/lib/ansible/modules/network/f5/bigip_sys_global.py b/lib/ansible/modules/network/f5/bigip_sys_global.py index 2219842a06..bd8ebdfb53 100644 --- a/lib/ansible/modules/network/f5/bigip_sys_global.py +++ b/lib/ansible/modules/network/f5/bigip_sys_global.py @@ -89,7 +89,7 @@ RETURN = r''' banner_text: description: The new text to present in the advisory banner. returned: changed - type: string + type: str sample: This is a corporate device. Do not touch. console_timeout: description: diff --git a/lib/ansible/modules/network/f5/bigip_timer_policy.py b/lib/ansible/modules/network/f5/bigip_timer_policy.py index 5ee04ad689..eef85e83c4 100644 --- a/lib/ansible/modules/network/f5/bigip_timer_policy.py +++ b/lib/ansible/modules/network/f5/bigip_timer_policy.py @@ -139,7 +139,7 @@ RETURN = r''' description: description: The new description of the timer policy. returned: changed - type: string + type: str sample: true ''' diff --git a/lib/ansible/modules/network/f5/bigip_traffic_selector.py b/lib/ansible/modules/network/f5/bigip_traffic_selector.py index 5956b4b9d8..94b2977b61 100644 --- a/lib/ansible/modules/network/f5/bigip_traffic_selector.py +++ b/lib/ansible/modules/network/f5/bigip_traffic_selector.py @@ -84,17 +84,17 @@ RETURN = r''' destination_address: description: The new Destination IP Address. returned: changed - type: string + type: str sample: 1.2.3.4/32 source_address: description: The new Source IP address. returned: changed - type: string + type: str sample: 2.3.4.5/32 ipsec_policy: description: The new IPSec policy. returned: changed - type: string + type: str sample: /Common/policy1 order: description: The new sort order. diff --git a/lib/ansible/modules/network/f5/bigip_trunk.py b/lib/ansible/modules/network/f5/bigip_trunk.py index e7cfa0e1e6..e032688060 100644 --- a/lib/ansible/modules/network/f5/bigip_trunk.py +++ b/lib/ansible/modules/network/f5/bigip_trunk.py @@ -143,24 +143,24 @@ RETURN = r''' lacp_mode: description: Operation mode for LACP if the lacp option is enabled for the trunk. returned: changed - type: string + type: str sample: active lacp_timeout: description: Rate at which the system sends the LACP control packets. returned: changed - type: string + type: str sample: long link_selection_policy: description: - LACP policy that the trunk uses to determine which member link (interface) can handle new traffic. returned: changed - type: string + type: str sample: auto frame_distribution_hash: description: Hash that the system uses as the frame distribution algorithm. returned: changed - type: string + type: str sample: src-dst-ipport lacp_enabled: description: Whether the system supports the link aggregation control protocol (LACP) or not. @@ -175,12 +175,12 @@ interfaces: description: description: Description of the trunk. returned: changed - type: string + type: str sample: My trunk qinq_ethertype: description: Ether-type value used for the packets handled on this trunk when it is a member in a QinQ vlan. returned: changed - type: string + type: str sample: 0x9100 ''' diff --git a/lib/ansible/modules/network/f5/bigip_tunnel.py b/lib/ansible/modules/network/f5/bigip_tunnel.py index 9961ee628b..ea8e2c7b6d 100644 --- a/lib/ansible/modules/network/f5/bigip_tunnel.py +++ b/lib/ansible/modules/network/f5/bigip_tunnel.py @@ -169,7 +169,7 @@ param1: param2: description: The new param2 value of the resource. returned: changed - type: string + type: str sample: Foo is bar ''' diff --git a/lib/ansible/modules/network/f5/bigip_ucs_fetch.py b/lib/ansible/modules/network/f5/bigip_ucs_fetch.py index cd8369c633..aa68f4cc65 100644 --- a/lib/ansible/modules/network/f5/bigip_ucs_fetch.py +++ b/lib/ansible/modules/network/f5/bigip_ucs_fetch.py @@ -88,24 +88,24 @@ RETURN = r''' checksum: description: The SHA1 checksum of the downloaded file returned: success or changed - type: string + type: str sample: 7b46bbe4f8ebfee64761b5313855618f64c64109 dest: description: Location on the ansible host that the UCS was saved to returned: success - type: string + type: str sample: /path/to/file.txt src: description: - Name of the UCS file on the remote BIG-IP to download. If not specified, then this will be a randomly generated filename returned: changed - type: string + type: str sample: cs_backup.ucs backup_file: description: Name of backup file created returned: changed and if backup=yes - type: string + type: str sample: /path/to/file.txt.2015-02-12@22:09~ gid: description: Group id of the UCS file, after execution @@ -115,12 +115,12 @@ gid: group: description: Group of the UCS file, after execution returned: success - type: string + type: str sample: httpd owner: description: Owner of the UCS file, after execution returned: success - type: string + type: str sample: httpd uid: description: Owner id of the UCS file, after execution @@ -130,12 +130,12 @@ uid: md5sum: description: The MD5 checksum of the downloaded file returned: changed or success - type: string + type: str sample: 96cacab4c259c4598727d7cf2ceb3b45 mode: description: Permissions of the target UCS, after execution returned: success - type: string + type: str sample: 0644 size: description: Size of the target UCS, after execution diff --git a/lib/ansible/modules/network/f5/bigip_user.py b/lib/ansible/modules/network/f5/bigip_user.py index b44f31fee9..2c8fa25758 100644 --- a/lib/ansible/modules/network/f5/bigip_user.py +++ b/lib/ansible/modules/network/f5/bigip_user.py @@ -180,7 +180,7 @@ RETURN = r''' full_name: description: Full name of the user returned: changed and success - type: string + type: str sample: John Doe partition_access: description: @@ -192,7 +192,7 @@ partition_access: shell: description: The shell assigned to the user account returned: changed and success - type: string + type: str sample: tmsh ''' diff --git a/lib/ansible/modules/network/f5/bigip_virtual_address.py b/lib/ansible/modules/network/f5/bigip_virtual_address.py index 3b86523c3a..df4684fcc1 100644 --- a/lib/ansible/modules/network/f5/bigip_virtual_address.py +++ b/lib/ansible/modules/network/f5/bigip_virtual_address.py @@ -227,12 +227,12 @@ use_route_advertisement: auto_delete: description: New setting for auto deleting virtual address. returned: changed - type: string + type: str sample: enabled icmp_echo: description: New ICMP echo setting applied to virtual address. returned: changed - type: string + type: str sample: disabled connection_limit: description: The new connection limit of the virtual address. @@ -257,12 +257,12 @@ address: state: description: The new state of the virtual address. returned: changed - type: string + type: str sample: disabled spanning: description: Whether spanning is enabled or not returned: changed - type: string + type: str sample: disabled ''' diff --git a/lib/ansible/modules/network/f5/bigip_virtual_server.py b/lib/ansible/modules/network/f5/bigip_virtual_server.py index aabb89afd1..430b707d69 100644 --- a/lib/ansible/modules/network/f5/bigip_virtual_server.py +++ b/lib/ansible/modules/network/f5/bigip_virtual_server.py @@ -574,17 +574,17 @@ RETURN = r''' description: description: New description of the virtual server. returned: changed - type: string + type: str sample: This is my description default_persistence_profile: description: Default persistence profile set on the virtual server. returned: changed - type: string + type: str sample: /Common/dest_addr destination: description: Destination of the virtual server. returned: changed - type: string + type: str sample: 1.1.1.1 disabled: description: Whether the virtual server is disabled, or not. @@ -609,7 +609,7 @@ enabled_vlans: fallback_persistence_profile: description: Fallback persistence profile set on the virtual server. returned: changed - type: string + type: str sample: /Common/source_addr irules: description: iRules set on the virtual server. @@ -619,7 +619,7 @@ irules: pool: description: Pool that the virtual server is attached to. returned: changed - type: string + type: str sample: /Common/my-pool policies: description: List of policies attached to the virtual. @@ -639,12 +639,12 @@ profiles: snat: description: SNAT setting of the virtual server. returned: changed - type: string + type: str sample: Automap source: description: Source address, in CIDR form, set on the virtual server. returned: changed - type: string + type: str sample: 1.2.3.4/32 metadata: description: The new value of the virtual. @@ -664,7 +664,7 @@ port_translation: source_port: description: Specifies whether the system preserves the source port of the connection. returned: changed - type: string + type: str sample: change mirror: description: Specifies that the system mirrors connections on each member of a redundant pair. @@ -679,12 +679,12 @@ ip_protocol: firewall_enforced_policy: description: The new enforcing firewall policy. returned: changed - type: string + type: str sample: /Common/my-enforced-fw firewall_staged_policy: description: The new staging firewall policy. returned: changed - type: string + type: str sample: /Common/my-staged-fw security_log_profiles: description: The new list of security log profiles. @@ -694,7 +694,7 @@ security_log_profiles: ip_intelligence_policy: description: The new IP Intelligence Policy assigned to the virtual. returned: changed - type: string + type: str sample: /Common/ip-intelligence ''' diff --git a/lib/ansible/modules/network/f5/bigip_vlan.py b/lib/ansible/modules/network/f5/bigip_vlan.py index 7e97c74b93..4db3e8a5e7 100644 --- a/lib/ansible/modules/network/f5/bigip_vlan.py +++ b/lib/ansible/modules/network/f5/bigip_vlan.py @@ -224,7 +224,7 @@ RETURN = r''' description: description: The description set on the VLAN. returned: changed - type: string + type: str sample: foo VLAN interfaces: description: Interfaces that the VLAN is assigned to. @@ -234,7 +234,7 @@ interfaces: partition: description: The partition that the VLAN was created on. returned: changed - type: string + type: str sample: Common tag: description: The ID of the VLAN. @@ -244,12 +244,12 @@ tag: cmp_hash: description: New traffic disaggregation method. returned: changed - type: string + type: str sample: source-address dag_tunnel: description: The new DAG tunnel setting. returned: changed - type: string + type: str sample: outer source_check: description: The new Source Check setting. @@ -269,7 +269,7 @@ fail_safe_timeout: fail_safe_action: description: The new Fail Safe Action setting. returned: changed - type: string + type: str sample: reboot sflow_poll_interval: description: The new sFlow Polling Interval setting. diff --git a/lib/ansible/modules/network/f5/bigiq_application_fasthttp.py b/lib/ansible/modules/network/f5/bigiq_application_fasthttp.py index 03b1c0806f..8c3ba0e9af 100644 --- a/lib/ansible/modules/network/f5/bigiq_application_fasthttp.py +++ b/lib/ansible/modules/network/f5/bigiq_application_fasthttp.py @@ -134,22 +134,22 @@ RETURN = r''' description: description: The new description of the application of the resource. returned: changed - type: string + type: str sample: My application service_environment: description: The environment which the service was deployed to. returned: changed - type: string + type: str sample: my-ssg1 inbound_virtual_destination: description: The destination of the virtual that was created. returned: changed - type: string + type: str sample: 6.7.8.9 inbound_virtual_netmask: description: The network mask of the provided inbound destination. returned: changed - type: string + type: str sample: 255.255.255.0 inbound_virtual_port: description: The port the inbound virtual address listens on. @@ -164,7 +164,7 @@ servers: address: description: The IP address of the server. returned: changed - type: string + type: str sample: 2.3.4.5 port: description: The port that the server listens on. diff --git a/lib/ansible/modules/network/f5/bigiq_application_fastl4_tcp.py b/lib/ansible/modules/network/f5/bigiq_application_fastl4_tcp.py index 192b25d94e..4119067d0a 100644 --- a/lib/ansible/modules/network/f5/bigiq_application_fastl4_tcp.py +++ b/lib/ansible/modules/network/f5/bigiq_application_fastl4_tcp.py @@ -134,22 +134,22 @@ RETURN = r''' description: description: The new description of the application of the resource. returned: changed - type: string + type: str sample: My application service_environment: description: The environment which the service was deployed to. returned: changed - type: string + type: str sample: my-ssg1 inbound_virtual_destination: description: The destination of the virtual that was created. returned: changed - type: string + type: str sample: 6.7.8.9 inbound_virtual_netmask: description: The network mask of the provided inbound destination. returned: changed - type: string + type: str sample: 255.255.255.0 inbound_virtual_port: description: The port the inbound virtual address listens on. @@ -164,7 +164,7 @@ servers: address: description: The IP address of the server. returned: changed - type: string + type: str sample: 2.3.4.5 port: description: The port that the server listens on. diff --git a/lib/ansible/modules/network/f5/bigiq_application_fastl4_udp.py b/lib/ansible/modules/network/f5/bigiq_application_fastl4_udp.py index 33082cf4f6..c148e2d965 100644 --- a/lib/ansible/modules/network/f5/bigiq_application_fastl4_udp.py +++ b/lib/ansible/modules/network/f5/bigiq_application_fastl4_udp.py @@ -134,22 +134,22 @@ RETURN = r''' description: description: The new description of the application of the resource. returned: changed - type: string + type: str sample: My application service_environment: description: The environment which the service was deployed to. returned: changed - type: string + type: str sample: my-ssg1 inbound_virtual_destination: description: The destination of the virtual that was created. returned: changed - type: string + type: str sample: 6.7.8.9 inbound_virtual_netmask: description: The network mask of the provided inbound destination. returned: changed - type: string + type: str sample: 255.255.255.0 inbound_virtual_port: description: The port the inbound virtual address listens on. @@ -164,7 +164,7 @@ servers: address: description: The IP address of the server. returned: changed - type: string + type: str sample: 2.3.4.5 port: description: The port that the server listens on. diff --git a/lib/ansible/modules/network/f5/bigiq_application_http.py b/lib/ansible/modules/network/f5/bigiq_application_http.py index 21f85a080d..0de6293c16 100644 --- a/lib/ansible/modules/network/f5/bigiq_application_http.py +++ b/lib/ansible/modules/network/f5/bigiq_application_http.py @@ -134,22 +134,22 @@ RETURN = r''' description: description: The new description of the application of the resource. returned: changed - type: string + type: str sample: My application service_environment: description: The environment which the service was deployed to. returned: changed - type: string + type: str sample: my-ssg1 inbound_virtual_destination: description: The destination of the virtual that was created. returned: changed - type: string + type: str sample: 6.7.8.9 inbound_virtual_netmask: description: The network mask of the provided inbound destination. returned: changed - type: string + type: str sample: 255.255.255.0 inbound_virtual_port: description: The port the inbound virtual address listens on. @@ -164,7 +164,7 @@ servers: address: description: The IP address of the server. returned: changed - type: string + type: str sample: 2.3.4.5 port: description: The port that the server listens on. diff --git a/lib/ansible/modules/network/f5/bigiq_application_https_offload.py b/lib/ansible/modules/network/f5/bigiq_application_https_offload.py index 562b6666c3..1470f1d6f4 100644 --- a/lib/ansible/modules/network/f5/bigiq_application_https_offload.py +++ b/lib/ansible/modules/network/f5/bigiq_application_https_offload.py @@ -190,22 +190,22 @@ RETURN = r''' description: description: The new description of the application of the resource. returned: changed - type: string + type: str sample: My application service_environment: description: The environment which the service was deployed to. returned: changed - type: string + type: str sample: my-ssg1 inbound_virtual_destination: description: The destination of the virtual that was created. returned: changed - type: string + type: str sample: 6.7.8.9 inbound_virtual_netmask: description: The network mask of the provided inbound destination. returned: changed - type: string + type: str sample: 255.255.255.0 inbound_virtual_port: description: The port the inbound virtual address listens on. @@ -220,7 +220,7 @@ servers: address: description: The IP address of the server. returned: changed - type: string + type: str sample: 2.3.4.5 port: description: The port that the server listens on. diff --git a/lib/ansible/modules/network/f5/bigiq_application_https_waf.py b/lib/ansible/modules/network/f5/bigiq_application_https_waf.py index 4e5c6eb9d7..ec3a857c18 100644 --- a/lib/ansible/modules/network/f5/bigiq_application_https_waf.py +++ b/lib/ansible/modules/network/f5/bigiq_application_https_waf.py @@ -195,22 +195,22 @@ RETURN = r''' description: description: The new description of the application of the resource. returned: changed - type: string + type: str sample: My application service_environment: description: The environment which the service was deployed to. returned: changed - type: string + type: str sample: my-ssg1 inbound_virtual_destination: description: The destination of the virtual that was created. returned: changed - type: string + type: str sample: 6.7.8.9 inbound_virtual_netmask: description: The network mask of the provided inbound destination. returned: changed - type: string + type: str sample: 255.255.255.0 inbound_virtual_port: description: The port the inbound virtual address listens on. @@ -225,7 +225,7 @@ servers: address: description: The IP address of the server. returned: changed - type: string + type: str sample: 2.3.4.5 port: description: The port that the server listens on. diff --git a/lib/ansible/modules/network/f5/bigiq_device_facts.py b/lib/ansible/modules/network/f5/bigiq_device_facts.py index eb00857dc0..3d45926bd3 100644 --- a/lib/ansible/modules/network/f5/bigiq_device_facts.py +++ b/lib/ansible/modules/network/f5/bigiq_device_facts.py @@ -91,25 +91,25 @@ applications: description: - The type of F5 Web Application Security Service protection on the application. returned: changed - type: string + type: str sample: Not Protected id: description: - ID of the application as known to the BIG-IQ. returned: changed - type: string + type: str sample: 996baae8-5d1d-3662-8a2d-3612fa2aceae name: description: - Name of the application. returned: changed - type: string + type: str sample: site12http.example.com status: description: - Current state of the application. returned: changed - type: string + type: str sample: DEPLOYED transactions_per_second: description: @@ -139,7 +139,7 @@ applications: description: - Health of the application. returned: changed - type: string + type: str sample: Good active_alerts: description: @@ -176,37 +176,37 @@ managed_devices: description: - Address where the device was discovered. returned: changed - type: string + type: str sample: 10.10.10.10 build: description: - Build of the version. returned: changed - type: string + type: str sample: 0.0.4 device_uri: description: - URI to reach the management interface of the device. returned: changed - type: string + type: str sample: "https://10.10.10.10:443" edition: description: - Edition string of the product version. returned: changed - type: string + type: str sample: Final group_name: description: - BIG-IQ group that the device is a member of. returned: changed - type: string + type: str sample: cm-bigip-allBigIpDevices hostname: description: - Discovered hostname of the device. returned: changed - type: string + type: str sample: tier2labB1.lab.fp.foo.com https_port: description: @@ -236,37 +236,37 @@ managed_devices: description: - Machine specific ID assigned to this device by BIG-IQ. returned: changed - type: string + type: str sample: c141bc88-f734-4434-be64-a3e9ea98356e management_address: description: - IP address of the management interface on the device. returned: changed - type: string + type: str sample: 10.10.10.10 mcp_device_name: description: - Device name as known by MCPD on the BIG-IP. returned: changed - type: string + type: str sample: /Common/tier2labB1.lab.fp.foo.com product: description: - Product that the managed device is identified as. returned: changed - type: string + type: str sample: BIG-IP rest_framework_version: description: - REST framework version running on the device returned: changed - type: string + type: str sample: 13.1.1-0.0.4 self_link: description: - Internal reference to the managed device in BIG-IQ. returned: changed - type: string + type: str sample: "https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e" slots: description: @@ -278,7 +278,7 @@ managed_devices: description: - State of the device. returned: changed - type: string + type: str sample: ACTIVE tags: description: @@ -290,19 +290,19 @@ managed_devices: description: - GUID of the trust domain the device is part of. returned: changed - type: string + type: str sample: 40ddf541-e604-4905-bde3005056813e36 uuid: description: - UUID of the device in BIG-IQ. returned: changed - type: string + type: str sample: c141bc88-f734-4434-be64-a3e9ea98356e version: description: - Version of TMOS installed on the device. returned: changed - type: string + type: str sample: 13.1.1 sample: hash/dictionary of values purchased_pool_licenses: @@ -314,13 +314,13 @@ purchased_pool_licenses: description: - Base registration key of the purchased pool returned: changed - type: string + type: str sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX dossier: description: - Dossier of the purchased pool license returned: changed - type: string + type: str sample: d6bd4b8ba5...e9a1a1199b73af9932948a free_device_licenses: description: @@ -332,13 +332,13 @@ purchased_pool_licenses: description: - Name of the purchased pool returned: changed - type: string + type: str sample: my-pool1 state: description: - State of the purchased pool license returned: changed - type: string + type: str sample: LICENSED total_device_licenses: description: @@ -350,55 +350,55 @@ purchased_pool_licenses: description: - UUID of the purchased pool license returned: changed - type: string + type: str sample: b2112329-cba7-4f1f-9a26-fab9be416d60 vendor: description: - Vendor who provided the license returned: changed - type: string + type: str sample: F5 Networks, Inc licensed_date_time: description: - Timestamp that the pool was licensed. returned: changed - type: string + type: str sample: "2018-09-10T00:00:00-07:00" licensed_version: description: - Version of BIG-IQ that is licensed. returned: changed - type: string + type: str sample: 6.0.1 evaluation_start_date_time: description: - Date that evaluation license starts. returned: changed - type: string + type: str sample: "2018-09-09T00:00:00-07:00" evaluation_end_date_time: description: - Date that evaluation license ends. returned: changed - type: string + type: str sample: "2018-10-11T00:00:00-07:00" license_end_date_time: description: - Date that the license expires. returned: changed - type: string + type: str sample: "2018-10-11T00:00:00-07:00" license_start_date_time: description: - Date that the license starts. returned: changed - type: string + type: str sample: "2018-09-09T00:00:00-07:00" registration_key: description: - Purchased pool license key. returned: changed - type: string + type: str sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX sample: hash/dictionary of values regkey_pools: @@ -410,13 +410,13 @@ regkey_pools: description: - Name of the regkey pool. returned: changed - type: string + type: str sample: pool1 id: description: - ID of the regkey pool. returned: changed - type: string + type: str sample: 4f9b565c-0831-4657-b6c2-6dde6182a502 total_offerings: description: @@ -432,61 +432,61 @@ regkey_pools: description: - Dossier of the license. returned: changed - type: string + type: str sample: d6bd4b8ba5...e9a1a1199b73af9932948a name: description: - Name of the regkey. returned: changed - type: string + type: str sample: regkey1 state: description: - State of the regkey license returned: changed - type: string + type: str sample: LICENSED licensed_date_time: description: - Timestamp that the regkey was licensed. returned: changed - type: string + type: str sample: "2018-09-10T00:00:00-07:00" licensed_version: description: - Version of BIG-IQ that is licensed. returned: changed - type: string + type: str sample: 6.0.1 evaluation_start_date_time: description: - Date that evaluation license starts. returned: changed - type: string + type: str sample: "2018-09-09T00:00:00-07:00" evaluation_end_date_time: description: - Date that evaluation license ends. returned: changed - type: string + type: str sample: "2018-10-11T00:00:00-07:00" license_end_date_time: description: - Date that the license expires. returned: changed - type: string + type: str sample: "2018-10-11T00:00:00-07:00" license_start_date_time: description: - Date that the license starts. returned: changed - type: string + type: str sample: "2018-09-09T00:00:00-07:00" registration_key: description: - Registration license key. returned: changed - type: string + type: str sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX sample: hash/dictionary of values sample: hash/dictionary of values @@ -499,13 +499,13 @@ system_info: description: - Media Access Control address (MAC address) of the device. returned: changed - type: string + type: str sample: "fa:16:3e:c3:42:6f" marketing_name: description: - Marketing name of the device platform. returned: changed - type: string + type: str sample: BIG-IQ Virtual Edition time: description: @@ -558,17 +558,17 @@ system_info: model: description: - The model of the hardware. - type: string + type: str sample: Virtual Disk name: description: - The name of the hardware. - type: string + type: str sample: HD1 type: description: - The type of hardware. - type: string + type: str sample: physical-disk versions: description: @@ -578,12 +578,12 @@ system_info: name: description: - Name of the property - type: string + type: str sample: Size version: description: - Value of the property - type: string + type: str sample: 154.00G is_admin_password_changed: description: @@ -607,27 +607,27 @@ system_info: description: - Displays the software edition. returned: changed - type: string + type: str sample: Point Release 7 package_version: description: - A string combining the C(product_build) and C(product_build_date). - type: string + type: str sample: "Build 0.0.1 - Tue May 15 15:26:30 PDT 2018" product_code: description: - Code identifying the product. - type: string + type: str sample: BIG-IQ product_build: description: - Build version of the release version. - type: string + type: str sample: 0.0.1 product_version: description: - Major product version of the running software. - type: string + type: str sample: 6.0.0 product_built: description: @@ -637,7 +637,7 @@ system_info: product_build_date: description: - Human readable build date. - type: string + type: str sample: "Tue May 15 15:26:30 PDT 2018" product_changelist: description: @@ -652,29 +652,29 @@ system_info: chassis_serial: description: - Serial of the chassis - type: string + type: str sample: 11111111-2222-3333-444444444444 host_board_part_revision: description: - Revision of the host board. - type: string + type: str host_board_serial: description: - Serial of the host board. - type: string + type: str platform: description: - Platform identifier. - type: string + type: str sample: Z100 switch_board_part_revision: description: - Switch board revision. - type: string + type: str switch_board_serial: description: - Serial of the switch board. - type: string + type: str uptime: description: - Time, in seconds, since the system booted. @@ -691,25 +691,25 @@ vlans: - Allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. returned: changed - type: string + type: str sample: enabled cmp_hash_algorithm: description: - Specifies how the traffic on the VLAN will be disaggregated. returned: changed - type: string + type: str sample: default description: description: - Description of the VLAN. returned: changed - type: string + type: str sample: My vlan failsafe_action: description: - Action for the system to take when the fail-safe mechanism is triggered. returned: changed - type: string + type: str sample: reboot failsafe_enabled: description: @@ -736,7 +736,7 @@ vlans: - Whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped. returned: changed - type: string + type: str sample: enable-forward interfaces: description: @@ -748,13 +748,13 @@ vlans: description: - Full name of the resource as known to BIG-IP. returned: changed - type: string + type: str sample: 1.3 name: description: - Relative name of the resource in BIG-IP. returned: changed - type: string + type: str sample: 1.3 tagged: description: @@ -804,7 +804,7 @@ vlans: description: - Media access control (MAC) address for the lowest-numbered interface assigned to this VLAN. returned: changed - type: string + type: str sample: "fa:16:3e:10:da:ff" tag: description: diff --git a/lib/ansible/modules/network/f5/bigiq_regkey_license.py b/lib/ansible/modules/network/f5/bigiq_regkey_license.py index e5a115ee8b..5d78401946 100644 --- a/lib/ansible/modules/network/f5/bigiq_regkey_license.py +++ b/lib/ansible/modules/network/f5/bigiq_regkey_license.py @@ -85,7 +85,7 @@ RETURN = r''' description: description: The new description of the license key. returned: changed - type: string + type: str sample: My license for BIG-IP 1 ''' diff --git a/lib/ansible/modules/network/f5/bigiq_regkey_pool.py b/lib/ansible/modules/network/f5/bigiq_regkey_pool.py index ca65d80e37..e2a52b48e4 100644 --- a/lib/ansible/modules/network/f5/bigiq_regkey_pool.py +++ b/lib/ansible/modules/network/f5/bigiq_regkey_pool.py @@ -66,7 +66,7 @@ RETURN = r''' description: description: New description of the regkey pool. returned: changed - type: string + type: str sample: My description ''' diff --git a/lib/ansible/modules/network/fortimanager/fmgr_device.py b/lib/ansible/modules/network/fortimanager/fmgr_device.py index 99e0704088..54c85c9bd3 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_device.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_device.py @@ -119,7 +119,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_device_config.py b/lib/ansible/modules/network/fortimanager/fmgr_device_config.py index cc34e958ce..16f497b0a8 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_device_config.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_device_config.py @@ -119,7 +119,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_device_group.py b/lib/ansible/modules/network/fortimanager/fmgr_device_group.py index 3756c3e185..7a8c272fb6 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_device_group.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_device_group.py @@ -150,7 +150,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_fwobj_address.py b/lib/ansible/modules/network/fortimanager/fmgr_fwobj_address.py index 76403712ad..a19f091f25 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_fwobj_address.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_fwobj_address.py @@ -316,7 +316,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ diff --git a/lib/ansible/modules/network/fortimanager/fmgr_fwobj_vip.py b/lib/ansible/modules/network/fortimanager/fmgr_fwobj_vip.py index 8ad130d26e..6b317993d5 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_fwobj_vip.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_fwobj_vip.py @@ -1781,7 +1781,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_fwpol_ipv4.py b/lib/ansible/modules/network/fortimanager/fmgr_fwpol_ipv4.py index 1904887559..34452bf0a3 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_fwpol_ipv4.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_fwpol_ipv4.py @@ -980,7 +980,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_ha.py b/lib/ansible/modules/network/fortimanager/fmgr_ha.py index 44bd0ef802..558fc3311a 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_ha.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_ha.py @@ -145,7 +145,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_provisioning.py b/lib/ansible/modules/network/fortimanager/fmgr_provisioning.py index d9ee688180..75d8ba5c7b 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_provisioning.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_provisioning.py @@ -142,7 +142,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_query.py b/lib/ansible/modules/network/fortimanager/fmgr_query.py index 939e22a6a2..fb725a81cf 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_query.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_query.py @@ -167,7 +167,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_script.py b/lib/ansible/modules/network/fortimanager/fmgr_script.py index b5ccc071a3..671faa5dde 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_script.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_script.py @@ -128,7 +128,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_secprof_dns.py b/lib/ansible/modules/network/fortimanager/fmgr_secprof_dns.py index 1f87a8df34..fc51ac36e0 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_secprof_dns.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_secprof_dns.py @@ -223,7 +223,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_secprof_profile_group.py b/lib/ansible/modules/network/fortimanager/fmgr_secprof_profile_group.py index 2174190a45..591d481b5e 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_secprof_profile_group.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_secprof_profile_group.py @@ -182,7 +182,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_secprof_ssl_ssh.py b/lib/ansible/modules/network/fortimanager/fmgr_secprof_ssl_ssh.py index cbdc481d46..8aa24a20f3 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_secprof_ssl_ssh.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_secprof_ssl_ssh.py @@ -711,7 +711,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_secprof_waf.py b/lib/ansible/modules/network/fortimanager/fmgr_secprof_waf.py index b42a045f1d..f31e27b233 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_secprof_waf.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_secprof_waf.py @@ -1066,7 +1066,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortimanager/fmgr_secprof_web.py b/lib/ansible/modules/network/fortimanager/fmgr_secprof_web.py index 8fb282b429..16ce242129 100644 --- a/lib/ansible/modules/network/fortimanager/fmgr_secprof_web.py +++ b/lib/ansible/modules/network/fortimanager/fmgr_secprof_web.py @@ -798,7 +798,7 @@ RETURN = """ api_result: description: full API response, includes status code and message returned: always - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule, env_fallback diff --git a/lib/ansible/modules/network/fortios/fortios_address.py b/lib/ansible/modules/network/fortios/fortios_address.py index fd5fcbb129..63dca31462 100644 --- a/lib/ansible/modules/network/fortios/fortios_address.py +++ b/lib/ansible/modules/network/fortios/fortios_address.py @@ -99,11 +99,11 @@ RETURN = """ firewall_address_config: description: full firewall adresses config string. returned: always - type: string + type: str change_string: description: The commands executed by the module. returned: only if config changed - type: string + type: str """ from ansible.module_utils.network.fortios.fortios import fortios_argument_spec, fortios_required_if diff --git a/lib/ansible/modules/network/fortios/fortios_application_list.py b/lib/ansible/modules/network/fortios/fortios_application_list.py index 32f715a036..7e6d99c0eb 100644 --- a/lib/ansible/modules/network/fortios/fortios_application_list.py +++ b/lib/ansible/modules/network/fortios/fortios_application_list.py @@ -359,57 +359,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_config.py b/lib/ansible/modules/network/fortios/fortios_config.py index 400cab4e1d..65498050b9 100644 --- a/lib/ansible/modules/network/fortios/fortios_config.py +++ b/lib/ansible/modules/network/fortios/fortios_config.py @@ -65,11 +65,11 @@ RETURN = """ running_config: description: full config string returned: always - type: string + type: str change_string: description: The commands really executed by the module returned: only if config changed - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_address.py b/lib/ansible/modules/network/fortios/fortios_firewall_address.py index 5bbe580824..b3beaf02dc 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_address.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_address.py @@ -262,57 +262,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_address6.py b/lib/ansible/modules/network/fortios/fortios_firewall_address6.py index c15319ed5d..0ba83b11db 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_address6.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_address6.py @@ -240,57 +240,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_address6_template.py b/lib/ansible/modules/network/fortios/fortios_firewall_address6_template.py index 34a03bfc6c..0b1b77a32d 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_address6_template.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_address6_template.py @@ -156,57 +156,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp.py b/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp.py index 75cb6710b0..64dcf4709f 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp.py @@ -170,57 +170,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp6.py b/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp6.py index f4e22e1199..e46fb87f55 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp6.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_addrgrp6.py @@ -163,57 +163,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_ippool.py b/lib/ansible/modules/network/fortios/fortios_firewall_ippool.py index 4da2a502fb..eeb0489680 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_ippool.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_ippool.py @@ -170,57 +170,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_ippool6.py b/lib/ansible/modules/network/fortios/fortios_firewall_ippool6.py index 32ac815ba5..e77dddcd2e 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_ippool6.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_ippool6.py @@ -119,57 +119,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_policy.py b/lib/ansible/modules/network/fortios/fortios_firewall_policy.py index 852d2658d3..99e6c6a41f 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_policy.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_policy.py @@ -897,57 +897,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py b/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py index 01ae58238d..394826eb7d 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_policy46.py @@ -233,57 +233,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_policy6.py b/lib/ansible/modules/network/fortios/fortios_firewall_policy6.py index c467b7c3ed..7f6de25d79 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_policy6.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_policy6.py @@ -592,57 +592,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_policy64.py b/lib/ansible/modules/network/fortios/fortios_firewall_policy64.py index 79149b0832..b963f3ef1b 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_policy64.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_policy64.py @@ -233,57 +233,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vip.py b/lib/ansible/modules/network/fortios/fortios_firewall_vip.py index b3ba22490b..4cb42e901a 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vip.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vip.py @@ -705,57 +705,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vip46.py b/lib/ansible/modules/network/fortios/fortios_firewall_vip46.py index f6825f3f0c..6f9989508f 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vip46.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vip46.py @@ -264,57 +264,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vip6.py b/lib/ansible/modules/network/fortios/fortios_firewall_vip6.py index 4f64ad1c83..a1bec2f149 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vip6.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vip6.py @@ -630,57 +630,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vip64.py b/lib/ansible/modules/network/fortios/fortios_firewall_vip64.py index f48c42596d..0d7c7315cf 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vip64.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vip64.py @@ -264,57 +264,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp.py b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp.py index 92648997ab..23fe8dba6b 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp.py @@ -134,57 +134,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp46.py b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp46.py index 2591c3fa61..49dddf443b 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp46.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp46.py @@ -130,57 +130,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp6.py b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp6.py index ee6fdc0c7a..acbc553988 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp6.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp6.py @@ -130,57 +130,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp64.py b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp64.py index 5d2416495c..57e7f29f6e 100644 --- a/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp64.py +++ b/lib/ansible/modules/network/fortios/fortios_firewall_vipgrp64.py @@ -130,57 +130,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_ips_sensor.py b/lib/ansible/modules/network/fortios/fortios_ips_sensor.py index 7efe39b088..2825a9a1bf 100644 --- a/lib/ansible/modules/network/fortios/fortios_ips_sensor.py +++ b/lib/ansible/modules/network/fortios/fortios_ips_sensor.py @@ -432,57 +432,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_ipv4_policy.py b/lib/ansible/modules/network/fortios/fortios_ipv4_policy.py index e5844aa278..67c6b162fa 100644 --- a/lib/ansible/modules/network/fortios/fortios_ipv4_policy.py +++ b/lib/ansible/modules/network/fortios/fortios_ipv4_policy.py @@ -184,15 +184,15 @@ RETURN = """ firewall_address_config: description: full firewall addresses config string returned: always - type: string + type: str change_string: description: The commands executed by the module returned: only if config changed - type: string + type: str msg_error_list: description: "List of errors returned by CLI (use -vvv for better readability)." returned: only when error - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/fortios/fortios_system_central_management.py b/lib/ansible/modules/network/fortios/fortios_system_central_management.py index 7c21a267d4..1595a8eaec 100644 --- a/lib/ansible/modules/network/fortios/fortios_system_central_management.py +++ b/lib/ansible/modules/network/fortios/fortios_system_central_management.py @@ -226,57 +226,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_system_sdn_connector.py b/lib/ansible/modules/network/fortios/fortios_system_sdn_connector.py index f018d460da..fc836bdd27 100644 --- a/lib/ansible/modules/network/fortios/fortios_system_sdn_connector.py +++ b/lib/ansible/modules/network/fortios/fortios_system_sdn_connector.py @@ -313,57 +313,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter.py b/lib/ansible/modules/network/fortios/fortios_webfilter.py index 1bf968fb21..966b6f120a 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter.py @@ -301,57 +301,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_content_header.py b/lib/ansible/modules/network/fortios/fortios_webfilter_content_header.py index af674e64c5..54a96a0a5b 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_content_header.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_content_header.py @@ -138,57 +138,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_fortiguard.py b/lib/ansible/modules/network/fortios/fortios_webfilter_fortiguard.py index 5281a59cfd..8de67adf47 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_fortiguard.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_fortiguard.py @@ -154,57 +154,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_cat.py b/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_cat.py index 7f3bc3e7f2..b8a1323279 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_cat.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_cat.py @@ -118,57 +118,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_rating.py b/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_rating.py index c6a8bef0bd..2c1262eb80 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_rating.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_ftgd_local_rating.py @@ -118,57 +118,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_cache_setting.py b/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_cache_setting.py index 40cae3329d..b037aa7d00 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_cache_setting.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_cache_setting.py @@ -103,57 +103,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting.py b/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting.py index 70ff095de7..62c4f83625 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting.py @@ -111,57 +111,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting6.py b/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting6.py index cd23d1e96e..9974fbc38b 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting6.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_ips_urlfilter_setting6.py @@ -111,57 +111,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_override.py b/lib/ansible/modules/network/fortios/fortios_webfilter_override.py index ef52d0d47b..6e7763a9a7 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_override.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_override.py @@ -155,57 +155,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_profile.py b/lib/ansible/modules/network/fortios/fortios_webfilter_profile.py index 9fc79f2b8c..97b1b4e8d8 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_profile.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_profile.py @@ -663,57 +663,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/fortios/fortios_webfilter_search_engine.py b/lib/ansible/modules/network/fortios/fortios_webfilter_search_engine.py index f067609e01..2317271ea5 100644 --- a/lib/ansible/modules/network/fortios/fortios_webfilter_search_engine.py +++ b/lib/ansible/modules/network/fortios/fortios_webfilter_search_engine.py @@ -138,57 +138,57 @@ RETURN = ''' build: description: Build number of the fortigate image returned: always - type: string + type: str sample: '1547' http_method: description: Last method used to provision the content into FortiGate returned: always - type: string + type: str sample: 'PUT' http_status: description: Last result given by FortiGate on last operation applied returned: always - type: string + type: str sample: "200" mkey: description: Master key (id) used in the last call to FortiGate returned: success - type: string + type: str sample: "key1" name: description: Name of the table used to fulfill the request returned: always - type: string + type: str sample: "urlfilter" path: description: Path of the table used to fulfill the request returned: always - type: string + type: str sample: "webfilter" revision: description: Internal revision number returned: always - type: string + type: str sample: "17.0.2.10658" serial: description: Serial number of the unit returned: always - type: string + type: str sample: "FGVMEVYYQT3AB5352" status: description: Indication of the operation's result returned: always - type: string + type: str sample: "success" vdom: description: Virtual domain used returned: always - type: string + type: str sample: "root" version: description: Version of the FortiGate returned: always - type: string + type: str sample: "v5.6.3" ''' diff --git a/lib/ansible/modules/network/ftd/ftd_file_download.py b/lib/ansible/modules/network/ftd/ftd_file_download.py index 3fac83698c..b238093d83 100644 --- a/lib/ansible/modules/network/ftd/ftd_file_download.py +++ b/lib/ansible/modules/network/ftd/ftd_file_download.py @@ -67,7 +67,7 @@ RETURN = """ msg: description: The error message describing why the module failed. returned: error - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import Connection diff --git a/lib/ansible/modules/network/ftd/ftd_file_upload.py b/lib/ansible/modules/network/ftd/ftd_file_upload.py index c0c5462382..fbbcc38833 100644 --- a/lib/ansible/modules/network/ftd/ftd_file_upload.py +++ b/lib/ansible/modules/network/ftd/ftd_file_upload.py @@ -64,7 +64,7 @@ RETURN = """ msg: description: The error message describing why the module failed. returned: error - type: string + type: str """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import Connection diff --git a/lib/ansible/modules/network/illumos/dladm_etherstub.py b/lib/ansible/modules/network/illumos/dladm_etherstub.py index f4db7e198d..341471f2f6 100644 --- a/lib/ansible/modules/network/illumos/dladm_etherstub.py +++ b/lib/ansible/modules/network/illumos/dladm_etherstub.py @@ -57,17 +57,17 @@ RETURN = ''' name: description: etherstub name returned: always - type: string + type: str sample: "switch0" state: description: state of the target returned: always - type: string + type: str sample: "present" temporary: description: etherstub's persistence returned: always - type: boolean + type: bool sample: "True" ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/illumos/dladm_iptun.py b/lib/ansible/modules/network/illumos/dladm_iptun.py index e32209145d..d46463fe08 100644 --- a/lib/ansible/modules/network/illumos/dladm_iptun.py +++ b/lib/ansible/modules/network/illumos/dladm_iptun.py @@ -76,32 +76,32 @@ RETURN = ''' name: description: tunnel interface name returned: always - type: string + type: str sample: iptun0 state: description: state of the target returned: always - type: string + type: str sample: present temporary: description: specifies if operation will persist across reboots returned: always - type: boolean + type: bool sample: True local_address: description: local IP address returned: always - type: string + type: str sample: 1.1.1.1/32 remote_address: description: remote IP address returned: always - type: string + type: str sample: 2.2.2.2/32 type: description: tunnel type returned: always - type: string + type: str sample: ipv4 ''' diff --git a/lib/ansible/modules/network/illumos/dladm_linkprop.py b/lib/ansible/modules/network/illumos/dladm_linkprop.py index 85ab04b38d..38722b6e09 100644 --- a/lib/ansible/modules/network/illumos/dladm_linkprop.py +++ b/lib/ansible/modules/network/illumos/dladm_linkprop.py @@ -66,27 +66,27 @@ RETURN = ''' property: description: property name returned: always - type: string + type: str sample: mtu state: description: state of the target returned: always - type: string + type: str sample: present temporary: description: specifies if operation will persist across reboots returned: always - type: boolean + type: bool sample: True link: description: link name returned: always - type: string + type: str sample: e100g0 value: description: property value returned: always - type: string + type: str sample: 9000 ''' diff --git a/lib/ansible/modules/network/illumos/dladm_vlan.py b/lib/ansible/modules/network/illumos/dladm_vlan.py index 591a49ce28..1110b39094 100644 --- a/lib/ansible/modules/network/illumos/dladm_vlan.py +++ b/lib/ansible/modules/network/illumos/dladm_vlan.py @@ -63,27 +63,27 @@ RETURN = ''' name: description: VLAN name returned: always - type: string + type: str sample: vlan42 state: description: state of the target returned: always - type: string + type: str sample: present temporary: description: specifies if operation will persist across reboots returned: always - type: boolean + type: bool sample: True link: description: VLAN's underlying link name returned: always - type: string + type: str sample: e100g0 vlan_id: description: VLAN ID returned: always - type: string + type: str sample: 42 ''' diff --git a/lib/ansible/modules/network/illumos/dladm_vnic.py b/lib/ansible/modules/network/illumos/dladm_vnic.py index ce4b4d9e18..314e1e5711 100644 --- a/lib/ansible/modules/network/illumos/dladm_vnic.py +++ b/lib/ansible/modules/network/illumos/dladm_vnic.py @@ -84,27 +84,27 @@ RETURN = ''' name: description: VNIC name returned: always - type: string + type: str sample: "vnic0" link: description: VNIC underlying link name returned: always - type: string + type: str sample: "igb0" state: description: state of the target returned: always - type: string + type: str sample: "present" temporary: description: VNIC's persistence returned: always - type: boolean + type: bool sample: "True" mac: description: MAC address to use for VNIC returned: if mac is specified - type: string + type: str sample: "00:00:5E:00:53:42" vlan: description: VLAN to use for VNIC diff --git a/lib/ansible/modules/network/illumos/flowadm.py b/lib/ansible/modules/network/illumos/flowadm.py index 184efc3853..aa382efa60 100644 --- a/lib/ansible/modules/network/illumos/flowadm.py +++ b/lib/ansible/modules/network/illumos/flowadm.py @@ -113,42 +113,42 @@ RETURN = ''' name: description: flow name returned: always - type: string + type: str sample: "http_drop" link: description: flow's link returned: if link is defined - type: string + type: str sample: "vnic0" state: description: state of the target returned: always - type: string + type: str sample: "present" temporary: description: flow's persistence returned: always - type: boolean + type: bool sample: "True" priority: description: flow's priority returned: if priority is defined - type: string + type: str sample: "low" transport: description: flow's transport returned: if transport is defined - type: string + type: str sample: "tcp" maxbw: description: flow's maximum bandwidth returned: if maxbw is defined - type: string + type: str sample: "100M" local_Ip: description: flow's local IP address returned: if local_ip is defined - type: string + type: str sample: "10.0.0.42" local_port: description: flow's local port @@ -158,12 +158,12 @@ local_port: remote_Ip: description: flow's remote IP address returned: if remote_ip is defined - type: string + type: str sample: "10.0.0.42" dsfield: description: flow's differentiated services value returned: if dsfield is defined - type: string + type: str sample: "0x2e:0xfc" ''' diff --git a/lib/ansible/modules/network/illumos/ipadm_addr.py b/lib/ansible/modules/network/illumos/ipadm_addr.py index 00916a625c..12f5337eee 100644 --- a/lib/ansible/modules/network/illumos/ipadm_addr.py +++ b/lib/ansible/modules/network/illumos/ipadm_addr.py @@ -77,32 +77,32 @@ RETURN = ''' addrobj: description: address object name returned: always - type: string + type: str sample: bge0/v4 state: description: state of the target returned: always - type: string + type: str sample: present temporary: description: specifies if operation will persist across reboots returned: always - type: boolean + type: bool sample: True addrtype: description: address type returned: always - type: string + type: str sample: static address: description: IP address returned: only if addrtype is 'static' - type: string + type: str sample: 1.3.3.7/32 wait: description: time we wait for DHCP returned: only if addrtype is 'dhcp' - type: string + type: str sample: 10 ''' diff --git a/lib/ansible/modules/network/illumos/ipadm_addrprop.py b/lib/ansible/modules/network/illumos/ipadm_addrprop.py index 3f897df681..b8ad751eae 100644 --- a/lib/ansible/modules/network/illumos/ipadm_addrprop.py +++ b/lib/ansible/modules/network/illumos/ipadm_addrprop.py @@ -63,27 +63,27 @@ RETURN = ''' property: description: property name returned: always - type: string + type: str sample: deprecated addrobj: description: address object name returned: always - type: string + type: str sample: bge0/v4 state: description: state of the target returned: always - type: string + type: str sample: present temporary: description: specifies if operation will persist across reboots returned: always - type: boolean + type: bool sample: True value: description: property value returned: when value is provided - type: string + type: str sample: 26 ''' diff --git a/lib/ansible/modules/network/illumos/ipadm_if.py b/lib/ansible/modules/network/illumos/ipadm_if.py index 61646ed9be..136bed694c 100644 --- a/lib/ansible/modules/network/illumos/ipadm_if.py +++ b/lib/ansible/modules/network/illumos/ipadm_if.py @@ -58,17 +58,17 @@ RETURN = ''' name: description: IP interface name returned: always - type: string + type: str sample: "vnic0" state: description: state of the target returned: always - type: string + type: str sample: "present" temporary: description: persistence of a IP interface returned: always - type: boolean + type: bool sample: "True" ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/illumos/ipadm_ifprop.py b/lib/ansible/modules/network/illumos/ipadm_ifprop.py index 94cff23466..b9a99701e0 100644 --- a/lib/ansible/modules/network/illumos/ipadm_ifprop.py +++ b/lib/ansible/modules/network/illumos/ipadm_ifprop.py @@ -88,7 +88,7 @@ interface: state: description: state of the target returned: always - type: string + type: str sample: present value: description: property's value diff --git a/lib/ansible/modules/network/illumos/ipadm_prop.py b/lib/ansible/modules/network/illumos/ipadm_prop.py index cc874ab264..dd3cbde9cd 100644 --- a/lib/ansible/modules/network/illumos/ipadm_prop.py +++ b/lib/ansible/modules/network/illumos/ipadm_prop.py @@ -61,22 +61,22 @@ RETURN = ''' protocol: description: property's protocol returned: always - type: string + type: str sample: "TCP" property: description: name of the property returned: always - type: string + type: str sample: "recv_maxbuf" state: description: state of the target returned: always - type: string + type: str sample: "present" temporary: description: property's persistence returned: always - type: boolean + type: bool sample: "True" value: description: value of the property. May be int or string depending on property. diff --git a/lib/ansible/modules/network/ingate/ig_unit_information.py b/lib/ansible/modules/network/ingate/ig_unit_information.py index ee9030fc8b..c4c2226499 100644 --- a/lib/ansible/modules/network/ingate/ig_unit_information.py +++ b/lib/ansible/modules/network/ingate/ig_unit_information.py @@ -46,47 +46,47 @@ unit-information: installid: description: The installation identifier returned: success - type: string + type: str sample: any interfaces: description: List of interface names returned: success - type: string + type: str sample: eth0 eth1 eth2 eth3 eth4 eth5 lang: description: The unit's language returned: success - type: string + type: str sample: en lic_email: description: License email information returned: success - type: string + type: str sample: example@example.com lic_mac: description: License MAC information returned: success - type: string + type: str sample: any lic_name: description: License name information returned: success - type: string + type: str sample: Example Inc macaddr: description: The MAC address of the first interface returned: success - type: string + type: str sample: 52:54:00:4c:e2:07 mode: description: Operational mode of the unit returned: success - type: string + type: str sample: Siparator modules: description: Installed module licenses returned: success - type: string + type: str sample: failover vpn sip qturn ems qos rsc voipsm patches: description: Installed patches on the unit @@ -96,27 +96,27 @@ unit-information: product: description: The product name returned: success - type: string + type: str sample: Software SIParator/Firewall serial: description: The serial number of the unit returned: success - type: string + type: str sample: IG-200-839-2008-0 systemid: description: The system identifier of the unit returned: success - type: string + type: str sample: IG-200-839-2008-0 unitname: description: The name of the unit returned: success - type: string + type: str sample: Testname version: description: Firmware version returned: success - type: string + type: str sample: 6.2.0-beta2 ''' diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index bc3aa4222e..6b010dd0e2 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -303,7 +303,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/ios_config.2016-07-16@22:28:34 """ import json diff --git a/lib/ansible/modules/network/ios/ios_facts.py b/lib/ansible/modules/network/ios/ios_facts.py index 33c3ce220a..2bbf6e6b14 100644 --- a/lib/ansible/modules/network/ios/ios_facts.py +++ b/lib/ansible/modules/network/ios/ios_facts.py @@ -74,27 +74,27 @@ ansible_net_gather_subset: ansible_net_model: description: The model name returned from the device returned: always - type: string + type: str ansible_net_serialnum: description: The serial number of the remote device returned: always - type: string + type: str ansible_net_version: description: The operating system version running on the remote device returned: always - type: string + type: str ansible_net_iostype: description: The operating system type (IOS or IOS-XE) running on the remote device returned: always - type: string + type: str ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str ansible_net_image: description: The image file the device is running returned: always - type: string + type: str ansible_net_stacked_models: description: The model names of each device in the stack returned: when multiple devices are configured in a stack @@ -126,7 +126,7 @@ ansible_net_memtotal_mb: ansible_net_config: description: The current active config from the device returned: when config is configured - type: string + type: str # interfaces ansible_net_all_ipv4_addresses: diff --git a/lib/ansible/modules/network/iosxr/iosxr_config.py b/lib/ansible/modules/network/iosxr/iosxr_config.py index 9cd4043ee7..4233e6897e 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_config.py +++ b/lib/ansible/modules/network/iosxr/iosxr_config.py @@ -181,7 +181,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/iosxr01.2016-07-16@22:28:34 """ import re diff --git a/lib/ansible/modules/network/iosxr/iosxr_facts.py b/lib/ansible/modules/network/iosxr/iosxr_facts.py index 68a5db122e..a83e60eb9d 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_facts.py +++ b/lib/ansible/modules/network/iosxr/iosxr_facts.py @@ -71,11 +71,11 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str ansible_net_image: description: The image file the device is running returned: always - type: string + type: str # hardware ansible_net_filesystems: diff --git a/lib/ansible/modules/network/ironware/ironware_config.py b/lib/ansible/modules/network/ironware/ironware_config.py index 287ab59bd6..7c06b80507 100644 --- a/lib/ansible/modules/network/ironware/ironware_config.py +++ b/lib/ansible/modules/network/ironware/ironware_config.py @@ -152,7 +152,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/junos/junos_banner.py b/lib/ansible/modules/network/junos/junos_banner.py index 976bd68631..8c17577bc2 100644 --- a/lib/ansible/modules/network/junos/junos_banner.py +++ b/lib/ansible/modules/network/junos/junos_banner.py @@ -96,7 +96,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit system login] + message \"this is my login banner\"; diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index 0e97a95f97..350ad737f4 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -199,7 +199,7 @@ RETURN = """ backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/config.2016-07-16@22:28:34 """ import re diff --git a/lib/ansible/modules/network/junos/junos_interface.py b/lib/ansible/modules/network/junos/junos_interface.py index ac6e688615..dfa155347d 100644 --- a/lib/ansible/modules/network/junos/junos_interface.py +++ b/lib/ansible/modules/network/junos/junos_interface.py @@ -180,7 +180,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit interfaces] + ge-0/0/1 { diff --git a/lib/ansible/modules/network/junos/junos_l2_interface.py b/lib/ansible/modules/network/junos/junos_l2_interface.py index 1bd5a2d1ae..d9c38c8265 100644 --- a/lib/ansible/modules/network/junos/junos_l2_interface.py +++ b/lib/ansible/modules/network/junos/junos_l2_interface.py @@ -124,7 +124,7 @@ RETURN = """ diff: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit interfaces] + ge-0/0/1 { diff --git a/lib/ansible/modules/network/junos/junos_l3_interface.py b/lib/ansible/modules/network/junos/junos_l3_interface.py index 3b8d3935bd..fd530c3dfa 100644 --- a/lib/ansible/modules/network/junos/junos_l3_interface.py +++ b/lib/ansible/modules/network/junos/junos_l3_interface.py @@ -93,7 +93,7 @@ RETURN = """ diff: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit interfaces ge-0/0/1 unit 0 family inet] + address 192.0.2.1/32; diff --git a/lib/ansible/modules/network/junos/junos_linkagg.py b/lib/ansible/modules/network/junos/junos_linkagg.py index 91be5e0fd4..8ccaead3f9 100644 --- a/lib/ansible/modules/network/junos/junos_linkagg.py +++ b/lib/ansible/modules/network/junos/junos_linkagg.py @@ -136,7 +136,7 @@ RETURN = """ diff: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit interfaces] + ge-0/0/6 { diff --git a/lib/ansible/modules/network/junos/junos_lldp.py b/lib/ansible/modules/network/junos/junos_lldp.py index 80840145ab..ee3cea458b 100644 --- a/lib/ansible/modules/network/junos/junos_lldp.py +++ b/lib/ansible/modules/network/junos/junos_lldp.py @@ -89,7 +89,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit] + protocols { diff --git a/lib/ansible/modules/network/junos/junos_lldp_interface.py b/lib/ansible/modules/network/junos/junos_lldp_interface.py index 2da78c62f2..4d64a1c066 100644 --- a/lib/ansible/modules/network/junos/junos_lldp_interface.py +++ b/lib/ansible/modules/network/junos/junos_lldp_interface.py @@ -88,7 +88,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit protocols lldp] + interface ge-0/0/5; diff --git a/lib/ansible/modules/network/junos/junos_logging.py b/lib/ansible/modules/network/junos/junos_logging.py index 3f99f749db..d459f2f664 100644 --- a/lib/ansible/modules/network/junos/junos_logging.py +++ b/lib/ansible/modules/network/junos/junos_logging.py @@ -127,7 +127,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit system syslog] + [edit system syslog] diff --git a/lib/ansible/modules/network/junos/junos_rpc.py b/lib/ansible/modules/network/junos/junos_rpc.py index 41c0413ee3..2bf0f1d233 100644 --- a/lib/ansible/modules/network/junos/junos_rpc.py +++ b/lib/ansible/modules/network/junos/junos_rpc.py @@ -83,11 +83,11 @@ RETURN = """ xml: description: The xml return string from the rpc request. returned: always - type: string + type: str output: description: The rpc rely converted to the output format. returned: always - type: string + type: str output_lines: description: The text output split into lines for readability. returned: always diff --git a/lib/ansible/modules/network/junos/junos_static_route.py b/lib/ansible/modules/network/junos/junos_static_route.py index fbb1aa28f9..59516a08d2 100644 --- a/lib/ansible/modules/network/junos/junos_static_route.py +++ b/lib/ansible/modules/network/junos/junos_static_route.py @@ -120,7 +120,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit routing-options static] route 2.2.2.0/24 { ... } diff --git a/lib/ansible/modules/network/junos/junos_system.py b/lib/ansible/modules/network/junos/junos_system.py index 638c655ca3..34e8dcc99d 100644 --- a/lib/ansible/modules/network/junos/junos_system.py +++ b/lib/ansible/modules/network/junos/junos_system.py @@ -96,7 +96,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit system] + host-name test; diff --git a/lib/ansible/modules/network/junos/junos_user.py b/lib/ansible/modules/network/junos/junos_user.py index 3a17bfe4a3..ac32a1bede 100644 --- a/lib/ansible/modules/network/junos/junos_user.py +++ b/lib/ansible/modules/network/junos/junos_user.py @@ -138,7 +138,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit system login] + user test-user { diff --git a/lib/ansible/modules/network/junos/junos_vlan.py b/lib/ansible/modules/network/junos/junos_vlan.py index 6cb087e6d0..01f8f565cd 100644 --- a/lib/ansible/modules/network/junos/junos_vlan.py +++ b/lib/ansible/modules/network/junos/junos_vlan.py @@ -113,7 +113,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit vlans] + test-vlan-1 { diff --git a/lib/ansible/modules/network/junos/junos_vrf.py b/lib/ansible/modules/network/junos/junos_vrf.py index 1ea4acae6f..6cf26d1d3d 100644 --- a/lib/ansible/modules/network/junos/junos_vrf.py +++ b/lib/ansible/modules/network/junos/junos_vrf.py @@ -155,7 +155,7 @@ RETURN = """ diff.prepared: description: Configuration difference before and after applying change. returned: when configuration is changed and diff option is enabled. - type: string + type: str sample: > [edit routing-instances] + test-1 { diff --git a/lib/ansible/modules/network/meraki/meraki_admin.py b/lib/ansible/modules/network/meraki/meraki_admin.py index 02b8b9f3e6..832bbcd95e 100644 --- a/lib/ansible/modules/network/meraki/meraki_admin.py +++ b/lib/ansible/modules/network/meraki/meraki_admin.py @@ -128,17 +128,17 @@ data: email: description: Email address of administrator. returned: success - type: string + type: str sample: your@email.com id: description: Unique identification number of administrator. returned: success - type: string + type: str sample: 1234567890 name: description: Given name of administrator. returned: success - type: string + type: str sample: John Doe networks: description: List of networks administrator has access on. @@ -148,12 +148,12 @@ data: id: description: The network ID. returned: when network permissions are set - type: string + type: str sample: N_0123456789 access: description: Access level of administrator. Options are 'full', 'read-only', or 'none'. returned: when network permissions are set - type: string + type: str sample: read-only tags: description: Tags the adminsitrator has access on. @@ -163,17 +163,17 @@ data: tag: description: Tag name. returned: when tag permissions are set - type: string + type: str sample: production access: description: Access level of administrator. Options are 'full', 'read-only', or 'none'. returned: when tag permissions are set - type: string + type: str sample: full orgAccess: description: The privilege of the dashboard administrator on the organization. Options are 'full', 'read-only', or 'none'. returned: success - type: string + type: str sample: full ''' diff --git a/lib/ansible/modules/network/meraki/meraki_config_template.py b/lib/ansible/modules/network/meraki/meraki_config_template.py index 55d02cd965..cad07e12bc 100644 --- a/lib/ansible/modules/network/meraki/meraki_config_template.py +++ b/lib/ansible/modules/network/meraki/meraki_config_template.py @@ -107,7 +107,7 @@ data: name: description: Name of configuration template returned: success - type: string + type: str sample: YourTemplate ''' diff --git a/lib/ansible/modules/network/meraki/meraki_mx_l3_firewall.py b/lib/ansible/modules/network/meraki/meraki_mx_l3_firewall.py index 0ebda7a16d..0414489b10 100644 --- a/lib/ansible/modules/network/meraki/meraki_mx_l3_firewall.py +++ b/lib/ansible/modules/network/meraki/meraki_mx_l3_firewall.py @@ -145,37 +145,37 @@ data: comment: description: Comment to describe the firewall rule. returned: always - type: string + type: str sample: Block traffic to server src_cidr: description: Comma separated list of CIDR notation source networks. returned: always - type: string + type: str sample: 192.0.1.1/32,192.0.1.2/32 src_port: description: Comma separated list of source ports. returned: always - type: string + type: str sample: 80,443 dest_cidr: description: Comma separated list of CIDR notation destination networks. returned: always - type: string + type: str sample: 192.0.1.1/32,192.0.1.2/32 dest_port: description: Comma separated list of destination ports. returned: always - type: string + type: str sample: 80,443 protocol: description: Network protocol for which to match against. returned: always - type: string + type: str sample: tcp policy: description: Action to take when rule is matched. returned: always - type: string + type: str syslog_enabled: description: Whether to log to syslog when rule is matched. returned: always diff --git a/lib/ansible/modules/network/meraki/meraki_network.py b/lib/ansible/modules/network/meraki/meraki_network.py index 2a8fb6ba03..9991b97354 100644 --- a/lib/ansible/modules/network/meraki/meraki_network.py +++ b/lib/ansible/modules/network/meraki/meraki_network.py @@ -103,32 +103,32 @@ data: id: description: Identification string of network. returned: success - type: string + type: str sample: N_12345 name: description: Written name of network. returned: success - type: string + type: str sample: YourNet organizationId: description: Organization ID which owns the network. returned: success - type: string + type: str sample: 0987654321 tags: description: Space delimited tags assigned to network. returned: success - type: string + type: str sample: " production wireless " timeZone: description: Timezone where network resides. returned: success - type: string + type: str sample: America/Chicago type: description: Functional type of network. returned: success - type: string + type: str sample: switch disableMyMerakiCom: description: States whether U(my.meraki.com) and other device portals should be disabled. diff --git a/lib/ansible/modules/network/meraki/meraki_organization.py b/lib/ansible/modules/network/meraki/meraki_organization.py index 2c5e4e64c8..16ef3f7efc 100644 --- a/lib/ansible/modules/network/meraki/meraki_organization.py +++ b/lib/ansible/modules/network/meraki/meraki_organization.py @@ -95,7 +95,7 @@ data: name: description: Name of organization returned: success - type: string + type: str sample: YourOrg ''' diff --git a/lib/ansible/modules/network/meraki/meraki_snmp.py b/lib/ansible/modules/network/meraki/meraki_snmp.py index 2188d60abd..da238f01c0 100644 --- a/lib/ansible/modules/network/meraki/meraki_snmp.py +++ b/lib/ansible/modules/network/meraki/meraki_snmp.py @@ -105,17 +105,17 @@ data: hostname: description: Hostname of SNMP server. returned: success - type: string + type: str sample: n1.meraki.com peerIps: description: Semi-colon delimited list of IPs which can poll SNMP information. returned: success - type: string + type: str sample: 192.0.1.1 port: description: Port number of SNMP. returned: success - type: string + type: str sample: 16100 v2cEnabled: description: Shows enabled state of SNMPv2c @@ -130,22 +130,22 @@ data: v3AuthMode: description: The SNMP version 3 authentication mode either MD5 or SHA. returned: success - type: string + type: str sample: SHA v3PrivMode: description: The SNMP version 3 privacy mode DES or AES128. returned: success - type: string + type: str sample: AES128 v2CommunityString: description: Automatically generated community string for SNMPv2c. returned: When SNMPv2c is enabled. - type: string + type: str sample: o/8zd-JaSb v3User: description: Automatically generated username for SNMPv3. returned: When SNMPv3c is enabled. - type: string + type: str sample: o/8zd-JaSb ''' diff --git a/lib/ansible/modules/network/meraki/meraki_vlan.py b/lib/ansible/modules/network/meraki/meraki_vlan.py index f47d809c37..d168240c1b 100644 --- a/lib/ansible/modules/network/meraki/meraki_vlan.py +++ b/lib/ansible/modules/network/meraki/meraki_vlan.py @@ -141,12 +141,12 @@ response: applianceIp: description: IP address of Meraki appliance in the VLAN returned: success - type: string + type: str sample: 192.0.1.1 dnsnamservers: description: IP address or Meraki defined DNS servers which VLAN should use by default returned: success - type: string + type: str sample: upstream_dns fixedIpAssignments: description: List of MAC addresses which have IP addresses assigned. @@ -161,12 +161,12 @@ response: ip: description: IP address which is assigned to the MAC address. returned: success - type: string + type: str sample: 192.0.1.4 name: description: Descriptive name for binding. returned: success - type: string + type: str sample: fixed_ip reservedIpRanges: description: List of IP address ranges which are reserved for static assignment. @@ -176,17 +176,17 @@ response: comment: description: Description for IP address reservation. returned: success - type: string + type: str sample: reserved_range end: description: Last IP address in reservation range. returned: success - type: string + type: str sample: 192.0.1.10 start: description: First IP address in reservation range. returned: success - type: string + type: str sample: 192.0.1.5 id: description: VLAN ID number. @@ -196,17 +196,17 @@ response: name: description: Descriptive name of VLAN returned: success - type: string + type: str sample: TestVLAN networkId: description: ID number of Meraki network which VLAN is associated to. returned: success - type: string + type: str sample: N_12345 subnet: description: CIDR notation IP subnet of VLAN. returned: success - type: string + type: str sample: 192.0.1.0/24 ''' diff --git a/lib/ansible/modules/network/netact/netact_cm_command.py b/lib/ansible/modules/network/netact/netact_cm_command.py index 7e5cca0329..41c2b0ae47 100644 --- a/lib/ansible/modules/network/netact/netact_cm_command.py +++ b/lib/ansible/modules/network/netact/netact_cm_command.py @@ -193,16 +193,16 @@ RETURN = ''' original_message: description: The original name param that was passed in returned: Command line - type: string + type: str sample: '/opt/oss/bin/racclimx.sh -op Upload -opsName Uploading_testi -DN PLMN-PLMN/MRBTS-746' message: description: The output message that the netact_cm_command module generates returned: Command output message - type: string + type: str changed: description: data changed returned: true if data is changed - type: boolean + type: bool ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/netconf/netconf_config.py b/lib/ansible/modules/network/netconf/netconf_config.py index da27b1fe8c..f4c8b0e651 100644 --- a/lib/ansible/modules/network/netconf/netconf_config.py +++ b/lib/ansible/modules/network/netconf/netconf_config.py @@ -204,7 +204,7 @@ server_capabilities: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/config.2016-07-16@22:28:34 diff: description: If --diff option in enabled while running, the before and after configuration change are diff --git a/lib/ansible/modules/network/netconf/netconf_get.py b/lib/ansible/modules/network/netconf/netconf_get.py index c1fcb20273..2ccd9f2c8b 100644 --- a/lib/ansible/modules/network/netconf/netconf_get.py +++ b/lib/ansible/modules/network/netconf/netconf_get.py @@ -124,7 +124,7 @@ stdout: description: The raw XML string containing configuration or state data received from the underlying ncclient library. returned: always apart from low-level errors (such as action plugin) - type: string + type: str sample: '...' stdout_lines: description: The value of stdout split into a list diff --git a/lib/ansible/modules/network/netconf/netconf_rpc.py b/lib/ansible/modules/network/netconf/netconf_rpc.py index c5399d1c0e..6878b9488a 100644 --- a/lib/ansible/modules/network/netconf/netconf_rpc.py +++ b/lib/ansible/modules/network/netconf/netconf_rpc.py @@ -123,7 +123,7 @@ stdout: description: The raw XML string containing configuration or state data received from the underlying ncclient library. returned: always apart from low-level errors (such as action plugin) - type: string + type: str sample: '...' stdout_lines: description: The value of stdout split into a list diff --git a/lib/ansible/modules/network/netscaler/netscaler_cs_action.py b/lib/ansible/modules/network/netscaler/netscaler_cs_action.py index 415d24ddb6..1fdb9619c5 100644 --- a/lib/ansible/modules/network/netscaler/netscaler_cs_action.py +++ b/lib/ansible/modules/network/netscaler/netscaler_cs_action.py @@ -83,13 +83,13 @@ loglines: msg: description: Message detailing the failure reason returned: failure - type: string + type: str sample: "Action does not exist" diff: description: List of differences between the actual configured object and the configuration specified in the module returned: failure - type: dictionary + type: dict sample: "{ 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }" ''' diff --git a/lib/ansible/modules/network/netscaler/netscaler_gslb_service.py b/lib/ansible/modules/network/netscaler/netscaler_gslb_service.py index acf9ff6f0e..f384dfaa1d 100644 --- a/lib/ansible/modules/network/netscaler/netscaler_gslb_service.py +++ b/lib/ansible/modules/network/netscaler/netscaler_gslb_service.py @@ -254,13 +254,13 @@ loglines: msg: description: Message detailing the failure reason returned: failure - type: string + type: str sample: "Action does not exist" diff: description: List of differences between the actual configured object and the configuration specified in the module returned: failure - type: dictionary + type: dict sample: "{ 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }" ''' diff --git a/lib/ansible/modules/network/netscaler/netscaler_gslb_site.py b/lib/ansible/modules/network/netscaler/netscaler_gslb_site.py index 93de56b3ea..7b332baf3c 100644 --- a/lib/ansible/modules/network/netscaler/netscaler_gslb_site.py +++ b/lib/ansible/modules/network/netscaler/netscaler_gslb_site.py @@ -169,13 +169,13 @@ loglines: msg: description: Message detailing the failure reason returned: failure - type: string + type: str sample: "Action does not exist" diff: description: List of differences between the actual configured object and the configuration specified in the module returned: failure - type: dictionary + type: dict sample: "{ 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }" ''' diff --git a/lib/ansible/modules/network/netscaler/netscaler_nitro_request.py b/lib/ansible/modules/network/netscaler/netscaler_nitro_request.py index 3f4257b4a2..3a5a138d90 100644 --- a/lib/ansible/modules/network/netscaler/netscaler_nitro_request.py +++ b/lib/ansible/modules/network/netscaler/netscaler_nitro_request.py @@ -249,13 +249,13 @@ nitro_errorcode: nitro_message: description: A string containing a human readable explanation for the NITRO operation result. returned: always - type: string + type: str sample: Success nitro_severity: description: A string describing the severity of the NITRO operation error or NONE. returned: always - type: string + type: str sample: NONE http_response_data: @@ -267,7 +267,7 @@ http_response_data: http_response_body: description: A string with the actual HTTP response body content if existent. If there is no HTTP response body it is an empty string. returned: always - type: string + type: str sample: "{ errorcode: 0, message: Done, severity: NONE }" nitro_object: @@ -287,7 +287,7 @@ nitro_object: nitro_auth_token: description: The token returned by the C(mas_login) operation when succesful. returned: when applicable - type: string + type: str sample: "##E8D7D74DDBD907EE579E8BB8FF4529655F22227C1C82A34BFC93C9539D66" ''' diff --git a/lib/ansible/modules/network/netscaler/netscaler_ssl_certkey.py b/lib/ansible/modules/network/netscaler/netscaler_ssl_certkey.py index 735147f1a1..43d1f593d8 100644 --- a/lib/ansible/modules/network/netscaler/netscaler_ssl_certkey.py +++ b/lib/ansible/modules/network/netscaler/netscaler_ssl_certkey.py @@ -133,13 +133,13 @@ loglines: msg: description: Message detailing the failure reason returned: failure - type: string + type: str sample: "Action does not exist" diff: description: List of differences between the actual configured object and the configuration specified in the module returned: failure - type: dictionary + type: dict sample: "{ 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }" ''' diff --git a/lib/ansible/modules/network/netvisor/pn_access_list.py b/lib/ansible/modules/network/netvisor/pn_access_list.py index dad43a95e4..c38a0f8c49 100644 --- a/lib/ansible/modules/network/netvisor/pn_access_list.py +++ b/lib/ansible/modules/network/netvisor/pn_access_list.py @@ -70,7 +70,7 @@ RETURN = """ command: description: the CLI command run on the target node. returned: always - type: string + type: str stdout: description: set of responses from the access-list command. returned: always diff --git a/lib/ansible/modules/network/netvisor/pn_access_list_ip.py b/lib/ansible/modules/network/netvisor/pn_access_list_ip.py index 95ad4cb27f..31fbdcac30 100644 --- a/lib/ansible/modules/network/netvisor/pn_access_list_ip.py +++ b/lib/ansible/modules/network/netvisor/pn_access_list_ip.py @@ -64,7 +64,7 @@ RETURN = """ command: description: the CLI command run on the target node. returned: always - type: string + type: str stdout: description: set of responses from the access-list-ip command. returned: always diff --git a/lib/ansible/modules/network/nos/nos_config.py b/lib/ansible/modules/network/nos/nos_config.py index fd0fa3b3e9..e6b0c9b811 100644 --- a/lib/ansible/modules/network/nos/nos_config.py +++ b/lib/ansible/modules/network/nos/nos_config.py @@ -187,7 +187,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/nos_config.2018-02-12@18:26:34 """ diff --git a/lib/ansible/modules/network/nos/nos_facts.py b/lib/ansible/modules/network/nos/nos_facts.py index 4abf3d4383..6280667a42 100644 --- a/lib/ansible/modules/network/nos/nos_facts.py +++ b/lib/ansible/modules/network/nos/nos_facts.py @@ -91,7 +91,7 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str # hardware ansible_net_memfree_mb: diff --git a/lib/ansible/modules/network/nso/nso_config.py b/lib/ansible/modules/network/nso/nso_config.py index f4d12e8d1f..f6f38280e6 100644 --- a/lib/ansible/modules/network/nso/nso_config.py +++ b/lib/ansible/modules/network/nso/nso_config.py @@ -94,11 +94,11 @@ changes: path: description: Path to value changed returned: always - type: string + type: str from: description: Previous value if any, else null returned: When previous value is present on value change - type: string + type: str to: description: Current value if any, else null. returned: When new value is present on value change @@ -131,11 +131,11 @@ diffs: path: description: keypath to service changed returned: always - type: string + type: str diff: description: configuration difference triggered the re-deploy returned: always - type: string + type: str ''' from ansible.module_utils.network.nso.nso import connect, verify_version, nso_argument_spec diff --git a/lib/ansible/modules/network/nso/nso_verify.py b/lib/ansible/modules/network/nso/nso_verify.py index 5aa5038b86..49304fb09e 100644 --- a/lib/ansible/modules/network/nso/nso_verify.py +++ b/lib/ansible/modules/network/nso/nso_verify.py @@ -81,15 +81,15 @@ violations: path: description: Path to the value in violation returned: always - type: string + type: str expected-value: description: Expected value of path returned: always - type: string + type: str value: description: Current value of path returned: always - type: string + type: str ''' from ansible.module_utils.network.nso.nso import connect, verify_version, nso_argument_spec diff --git a/lib/ansible/modules/network/nuage/nuage_vspk.py b/lib/ansible/modules/network/nuage/nuage_vspk.py index 6a147367e5..1fccd132a7 100644 --- a/lib/ansible/modules/network/nuage/nuage_vspk.py +++ b/lib/ansible/modules/network/nuage/nuage_vspk.py @@ -320,7 +320,7 @@ RETURN = ''' id: description: The id of the entity that was found, created, updated or assigned. returned: On state=present and command=find in case one entity was found. - type: string + type: str sample: bae07d8d-d29c-4e2b-b6ba-621b4807a333 entities: description: A list of entities handled. Each element is the to_dict() of the entity. diff --git a/lib/ansible/modules/network/nxos/_nxos_ip_interface.py b/lib/ansible/modules/network/nxos/_nxos_ip_interface.py index f4c5581bdb..5f87ec19bb 100644 --- a/lib/ansible/modules/network/nxos/_nxos_ip_interface.py +++ b/lib/ansible/modules/network/nxos/_nxos_ip_interface.py @@ -164,7 +164,7 @@ commands: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py b/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py index c1a84814b6..8be3812acf 100644 --- a/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py +++ b/lib/ansible/modules/network/nxos/nxos_aaa_server_host.py @@ -138,7 +138,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' import re diff --git a/lib/ansible/modules/network/nxos/nxos_config.py b/lib/ansible/modules/network/nxos/nxos_config.py index a8af295df7..1c343e0cf2 100644 --- a/lib/ansible/modules/network/nxos/nxos_config.py +++ b/lib/ansible/modules/network/nxos/nxos_config.py @@ -273,7 +273,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/nxos_config.2016-07-16@22:28:34 """ from ansible.module_utils._text import to_text diff --git a/lib/ansible/modules/network/nxos/nxos_facts.py b/lib/ansible/modules/network/nxos/nxos_facts.py index 7b66c00761..8fb7e519fc 100644 --- a/lib/ansible/modules/network/nxos/nxos_facts.py +++ b/lib/ansible/modules/network/nxos/nxos_facts.py @@ -90,11 +90,11 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str ansible_net_image: description: The image file the device is running returned: always - type: string + type: str # hardware ansible_net_filesystems: diff --git a/lib/ansible/modules/network/nxos/nxos_file_copy.py b/lib/ansible/modules/network/nxos/nxos_file_copy.py index 2c1491e9fd..6dcffc2b52 100644 --- a/lib/ansible/modules/network/nxos/nxos_file_copy.py +++ b/lib/ansible/modules/network/nxos/nxos_file_copy.py @@ -140,17 +140,17 @@ transfer_status: description: Whether a file was transferred. "No Transfer" or "Sent". If file_pull is successful, it is set to "Received". returned: success - type: string + type: str sample: 'Sent' local_file: description: The path of the local file. returned: success - type: string + type: str sample: '/path/to/local/file' remote_file: description: The path of the remote file. returned: success - type: string + type: str sample: '/path/to/remote/file' ''' diff --git a/lib/ansible/modules/network/nxos/nxos_gir.py b/lib/ansible/modules/network/nxos/nxos_gir.py index 414343ab61..652f7dcc4e 100644 --- a/lib/ansible/modules/network/nxos/nxos_gir.py +++ b/lib/ansible/modules/network/nxos/nxos_gir.py @@ -144,7 +144,7 @@ RETURN = ''' final_system_mode: description: describe the last system mode returned: verbose mode - type: string + type: str sample: normal updates: description: commands sent to the device @@ -154,7 +154,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py b/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py index 9e4abee040..1d59817067 100644 --- a/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py +++ b/lib/ansible/modules/network/nxos/nxos_gir_profile_management.py @@ -93,7 +93,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_igmp_interface.py b/lib/ansible/modules/network/nxos/nxos_igmp_interface.py index a3dc1b26e1..fc01f9a31d 100644 --- a/lib/ansible/modules/network/nxos/nxos_igmp_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_igmp_interface.py @@ -185,7 +185,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_install_os.py b/lib/ansible/modules/network/nxos/nxos_install_os.py index ef5d2df299..4105809155 100644 --- a/lib/ansible/modules/network/nxos/nxos_install_os.py +++ b/lib/ansible/modules/network/nxos/nxos_install_os.py @@ -100,7 +100,7 @@ RETURN = ''' install_state: description: Boot and install information. returned: always - type: dictionary + type: dict sample: { "install_state": [ "Compatibility check is done:", diff --git a/lib/ansible/modules/network/nxos/nxos_ntp.py b/lib/ansible/modules/network/nxos/nxos_ntp.py index 9bf83077ac..8bd9de059d 100644 --- a/lib/ansible/modules/network/nxos/nxos_ntp.py +++ b/lib/ansible/modules/network/nxos/nxos_ntp.py @@ -100,7 +100,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_ping.py b/lib/ansible/modules/network/nxos/nxos_ping.py index 9593aeb169..2fdabbe6c4 100644 --- a/lib/ansible/modules/network/nxos/nxos_ping.py +++ b/lib/ansible/modules/network/nxos/nxos_ping.py @@ -103,7 +103,7 @@ packets_tx: packet_loss: description: Percentage of packets lost returned: always - type: string + type: str sample: "0.00%" ''' from ansible.module_utils.network.nxos.nxos import run_commands diff --git a/lib/ansible/modules/network/nxos/nxos_reboot.py b/lib/ansible/modules/network/nxos/nxos_reboot.py index 6ba5fba96f..6c782e585b 100644 --- a/lib/ansible/modules/network/nxos/nxos_reboot.py +++ b/lib/ansible/modules/network/nxos/nxos_reboot.py @@ -54,7 +54,7 @@ RETURN = ''' rebooted: description: Whether the device was instructed to reboot. returned: success - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_rollback.py b/lib/ansible/modules/network/nxos/nxos_rollback.py index 76a5d260ff..31db1bde62 100644 --- a/lib/ansible/modules/network/nxos/nxos_rollback.py +++ b/lib/ansible/modules/network/nxos/nxos_rollback.py @@ -65,12 +65,12 @@ RETURN = ''' filename: description: The filename of the checkpoint/rollback file. returned: success - type: string + type: str sample: 'backup.cfg' status: description: Which operation took place and whether it was successful. returned: success - type: string + type: str sample: 'rollback executed' ''' diff --git a/lib/ansible/modules/network/nxos/nxos_udld.py b/lib/ansible/modules/network/nxos/nxos_udld.py index 40677d1b03..73b8b8a4b4 100644 --- a/lib/ansible/modules/network/nxos/nxos_udld.py +++ b/lib/ansible/modules/network/nxos/nxos_udld.py @@ -99,7 +99,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_udld_interface.py b/lib/ansible/modules/network/nxos/nxos_udld_interface.py index 479f72eaff..d0d861ae44 100644 --- a/lib/ansible/modules/network/nxos/nxos_udld_interface.py +++ b/lib/ansible/modules/network/nxos/nxos_udld_interface.py @@ -105,7 +105,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_domain.py b/lib/ansible/modules/network/nxos/nxos_vtp_domain.py index 53c4080207..c53092a22a 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_domain.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_domain.py @@ -82,7 +82,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_password.py b/lib/ansible/modules/network/nxos/nxos_vtp_password.py index d7540e0272..7ba62db787 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_password.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_password.py @@ -95,7 +95,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/network/nxos/nxos_vtp_version.py b/lib/ansible/modules/network/nxos/nxos_vtp_version.py index 469b2bb69b..e0508c9aa1 100644 --- a/lib/ansible/modules/network/nxos/nxos_vtp_version.py +++ b/lib/ansible/modules/network/nxos/nxos_vtp_version.py @@ -79,7 +79,7 @@ updates: changed: description: check to see if a change was made on the device returned: always - type: boolean + type: bool sample: true ''' from ansible.module_utils.network.nxos.nxos import load_config, run_commands diff --git a/lib/ansible/modules/network/onyx/onyx_config.py b/lib/ansible/modules/network/onyx/onyx_config.py index 58dd8f153f..2144ba02b4 100644 --- a/lib/ansible/modules/network/onyx/onyx_config.py +++ b/lib/ansible/modules/network/onyx/onyx_config.py @@ -120,7 +120,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/onyx_config.2016-07-16@22:28:34 """ diff --git a/lib/ansible/modules/network/ordnance/ordnance_config.py b/lib/ansible/modules/network/ordnance/ordnance_config.py index 82b925197c..bff7f71efa 100644 --- a/lib/ansible/modules/network/ordnance/ordnance_config.py +++ b/lib/ansible/modules/network/ordnance/ordnance_config.py @@ -163,7 +163,7 @@ updates: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/ordnance_config.2016-07-16@22:28:34 """ import re diff --git a/lib/ansible/modules/network/panos/panos_admin.py b/lib/ansible/modules/network/panos/panos_admin.py index a629b3e923..9ea051ff32 100644 --- a/lib/ansible/modules/network/panos/panos_admin.py +++ b/lib/ansible/modules/network/panos/panos_admin.py @@ -71,7 +71,7 @@ RETURN = ''' status: description: success status returned: success - type: string + type: str sample: "okey dokey" ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/panos/panos_admpwd.py b/lib/ansible/modules/network/panos/panos_admpwd.py index 130acf5c4e..b68b550e4f 100644 --- a/lib/ansible/modules/network/panos/panos_admpwd.py +++ b/lib/ansible/modules/network/panos/panos_admpwd.py @@ -69,7 +69,7 @@ RETURN = ''' status: description: success status returned: success - type: string + type: str sample: "Last login: Fri Sep 16 11:09:20 2016 from 10.35.34.56.....Configuration committed successfully" ''' diff --git a/lib/ansible/modules/network/panos/panos_commit.py b/lib/ansible/modules/network/panos/panos_commit.py index 8c8447e2d9..b16fe6d804 100644 --- a/lib/ansible/modules/network/panos/panos_commit.py +++ b/lib/ansible/modules/network/panos/panos_commit.py @@ -58,7 +58,7 @@ RETURN = ''' status: description: success status returned: success - type: string + type: str sample: "okey dokey" ''' diff --git a/lib/ansible/modules/network/panos/panos_lic.py b/lib/ansible/modules/network/panos/panos_lic.py index 611dcd1aee..536da8c4a2 100644 --- a/lib/ansible/modules/network/panos/panos_lic.py +++ b/lib/ansible/modules/network/panos/panos_lic.py @@ -64,7 +64,7 @@ RETURN = ''' serialnumber: description: serialnumber of the device in case that it has been already registered returned: success - type: string + type: str sample: 007200004214 ''' diff --git a/lib/ansible/modules/network/panos/panos_op.py b/lib/ansible/modules/network/panos/panos_op.py index edade2fd7b..a57fe55bad 100644 --- a/lib/ansible/modules/network/panos/panos_op.py +++ b/lib/ansible/modules/network/panos/panos_op.py @@ -79,13 +79,13 @@ RETURN = ''' stdout: description: output of the given OP command as JSON formatted string returned: success - type: string + type: str sample: "{system: {app-release-date: 2017/05/01 15:09:12}}" stdout_xml: description: output of the given OP command as JSON formatted string returned: success - type: string + type: str sample: "<response status=success><result><system><hostname>fw2</hostname>" ''' diff --git a/lib/ansible/modules/network/panos/panos_restart.py b/lib/ansible/modules/network/panos/panos_restart.py index 0444489e95..17d2d6b794 100644 --- a/lib/ansible/modules/network/panos/panos_restart.py +++ b/lib/ansible/modules/network/panos/panos_restart.py @@ -43,7 +43,7 @@ RETURN = ''' status: description: success status returned: success - type: string + type: str sample: "okey dokey" ''' diff --git a/lib/ansible/modules/network/radware/vdirect_commit.py b/lib/ansible/modules/network/radware/vdirect_commit.py index 29284baf83..d68d07ee6e 100644 --- a/lib/ansible/modules/network/radware/vdirect_commit.py +++ b/lib/ansible/modules/network/radware/vdirect_commit.py @@ -127,7 +127,7 @@ RETURN = ''' result: description: Message detailing actions result returned: success - type: string + type: str sample: "Requested actions were successfully performed on all devices." ''' diff --git a/lib/ansible/modules/network/radware/vdirect_file.py b/lib/ansible/modules/network/radware/vdirect_file.py index 33388933df..65f66804c0 100644 --- a/lib/ansible/modules/network/radware/vdirect_file.py +++ b/lib/ansible/modules/network/radware/vdirect_file.py @@ -106,7 +106,7 @@ RETURN = ''' result: description: Message detailing upload result returned: success - type: string + type: str sample: "Workflow template created" ''' diff --git a/lib/ansible/modules/network/radware/vdirect_runnable.py b/lib/ansible/modules/network/radware/vdirect_runnable.py index c0d867f038..28bbf44ee5 100644 --- a/lib/ansible/modules/network/radware/vdirect_runnable.py +++ b/lib/ansible/modules/network/radware/vdirect_runnable.py @@ -121,7 +121,7 @@ RETURN = ''' result: description: Message detailing run result returned: success - type: string + type: str sample: "Workflow action run completed." ''' diff --git a/lib/ansible/modules/network/routeros/routeros_facts.py b/lib/ansible/modules/network/routeros/routeros_facts.py index b5d65e8ae3..5452d4a727 100644 --- a/lib/ansible/modules/network/routeros/routeros_facts.py +++ b/lib/ansible/modules/network/routeros/routeros_facts.py @@ -61,19 +61,19 @@ ansible_net_gather_subset: ansible_net_model: description: The model name returned from the device returned: always - type: string + type: str ansible_net_serialnum: description: The serial number of the remote device returned: always - type: string + type: str ansible_net_version: description: The operating system version running on the remote device returned: always - type: string + type: str ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str # hardware ansible_net_spacefree_mb: @@ -97,7 +97,7 @@ ansible_net_memtotal_mb: ansible_net_config: description: The current active config from the device returned: when config is configured - type: string + type: str # interfaces ansible_net_all_ipv4_addresses: diff --git a/lib/ansible/modules/network/slxos/slxos_config.py b/lib/ansible/modules/network/slxos/slxos_config.py index 8931be731d..8ea8636689 100644 --- a/lib/ansible/modules/network/slxos/slxos_config.py +++ b/lib/ansible/modules/network/slxos/slxos_config.py @@ -221,7 +221,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/slxos_config.2018-02-12@18:26:34 """ import re diff --git a/lib/ansible/modules/network/slxos/slxos_facts.py b/lib/ansible/modules/network/slxos/slxos_facts.py index 2a3a4fee2c..a0f1c45137 100644 --- a/lib/ansible/modules/network/slxos/slxos_facts.py +++ b/lib/ansible/modules/network/slxos/slxos_facts.py @@ -91,7 +91,7 @@ ansible_net_version: ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str # hardware ansible_net_memfree_mb: diff --git a/lib/ansible/modules/network/sros/sros_config.py b/lib/ansible/modules/network/sros/sros_config.py index 2c63fe35cd..8bbcf797ab 100644 --- a/lib/ansible/modules/network/sros/sros_config.py +++ b/lib/ansible/modules/network/sros/sros_config.py @@ -200,7 +200,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/sros_config.2016-07-16@22:28:34 """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/network/voss/voss_config.py b/lib/ansible/modules/network/voss/voss_config.py index e843520405..ae34d8bdff 100644 --- a/lib/ansible/modules/network/voss/voss_config.py +++ b/lib/ansible/modules/network/voss/voss_config.py @@ -195,7 +195,7 @@ commands: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/vsp200_config.2018-08-21@15:00:21 """ from ansible.module_utils._text import to_text diff --git a/lib/ansible/modules/network/voss/voss_facts.py b/lib/ansible/modules/network/voss/voss_facts.py index 36e2584b2b..0a59e334d1 100644 --- a/lib/ansible/modules/network/voss/voss_facts.py +++ b/lib/ansible/modules/network/voss/voss_facts.py @@ -78,19 +78,19 @@ ansible_net_gather_subset: ansible_net_model: description: The model name returned from the device returned: always - type: string + type: str ansible_net_serialnum: description: The serial number of the remote device returned: always - type: string + type: str ansible_net_version: description: The operating system version running on the remote device returned: always - type: string + type: str ansible_net_hostname: description: The configured hostname of the device returned: always - type: string + type: str # hardware ansible_net_memfree_mb: @@ -106,7 +106,7 @@ ansible_net_memtotal_mb: ansible_net_config: description: The current active config from the device returned: when config is configured - type: string + type: str # interfaces ansible_net_all_ipv4_addresses: diff --git a/lib/ansible/modules/network/vyos/vyos_config.py b/lib/ansible/modules/network/vyos/vyos_config.py index 0a430fa85c..e36daa120a 100644 --- a/lib/ansible/modules/network/vyos/vyos_config.py +++ b/lib/ansible/modules/network/vyos/vyos_config.py @@ -130,7 +130,7 @@ filtered: backup_path: description: The full path to the backup file returned: when backup is yes - type: string + type: str sample: /playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34 """ import re diff --git a/lib/ansible/modules/notification/bearychat.py b/lib/ansible/modules/notification/bearychat.py index cf57154405..fd9d844d8b 100644 --- a/lib/ansible/modules/notification/bearychat.py +++ b/lib/ansible/modules/notification/bearychat.py @@ -86,7 +86,7 @@ RETURN = """ msg: description: execution result returned: success - type: string + type: str sample: "OK" """ diff --git a/lib/ansible/modules/notification/catapult.py b/lib/ansible/modules/notification/catapult.py index a150e9759f..fbb79de86c 100644 --- a/lib/ansible/modules/notification/catapult.py +++ b/lib/ansible/modules/notification/catapult.py @@ -86,7 +86,7 @@ RETURN = ''' changed: description: Whether the api accepted the message. returned: always - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/notification/cisco_spark.py b/lib/ansible/modules/notification/cisco_spark.py index 3365178ae4..16b519fcf1 100644 --- a/lib/ansible/modules/notification/cisco_spark.py +++ b/lib/ansible/modules/notification/cisco_spark.py @@ -110,7 +110,7 @@ message: - The Response Message returned by the Spark API. - Full Response Code explanations can be found at U(https://developer.ciscospark.com/endpoint-messages-post.html). returned: always - type: string + type: str sample: OK (585 bytes) """ from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/notification/mattermost.py b/lib/ansible/modules/notification/mattermost.py index d53522eac1..836b31be06 100644 --- a/lib/ansible/modules/notification/mattermost.py +++ b/lib/ansible/modules/notification/mattermost.py @@ -82,11 +82,11 @@ RETURN = ''' payload: description: Mattermost payload returned: success - type: string + type: str webhook_url: description: URL the webhook is sent to returned: success - type: string + type: str ''' from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/notification/rocketchat.py b/lib/ansible/modules/notification/rocketchat.py index 1652027646..34c4190839 100644 --- a/lib/ansible/modules/notification/rocketchat.py +++ b/lib/ansible/modules/notification/rocketchat.py @@ -139,7 +139,7 @@ RETURN = """ changed: description: A flag indicating if any change was made or not. returned: success - type: boolean + type: bool sample: false """ diff --git a/lib/ansible/modules/notification/telegram.py b/lib/ansible/modules/notification/telegram.py index 369618a29c..95166b7669 100644 --- a/lib/ansible/modules/notification/telegram.py +++ b/lib/ansible/modules/notification/telegram.py @@ -63,12 +63,12 @@ RETURN = """ msg: description: The message you attempted to send returned: success - type: string + type: str sample: "Ansible task finished" telegram_error: description: Error message gotten from Telegram API returned: failure - type: string + type: str sample: "Bad Request: message text is empty" """ diff --git a/lib/ansible/modules/packaging/language/pip.py b/lib/ansible/modules/packaging/language/pip.py index 65923648bb..665af6f989 100644 --- a/lib/ansible/modules/packaging/language/pip.py +++ b/lib/ansible/modules/packaging/language/pip.py @@ -211,7 +211,7 @@ RETURN = ''' cmd: description: pip command used by the module returned: success - type: string + type: str sample: pip2 install ansible six name: description: list of python modules targetted by pip @@ -221,17 +221,17 @@ name: requirements: description: Path to the requirements file returned: success, if a requirements file was provided - type: string + type: str sample: "/srv/git/project/requirements.txt" version: description: Version of the package specified in 'name' returned: success, if a name and version were provided - type: string + type: str sample: "2.5.1" virtualenv: description: Path to the virtualenv returned: success, if a virtualenv path was provided - type: string + type: str sample: "/tmp/virtualenv" ''' diff --git a/lib/ansible/modules/packaging/language/yarn.py b/lib/ansible/modules/packaging/language/yarn.py index f5bc45b3d7..a3b8ae276a 100644 --- a/lib/ansible/modules/packaging/language/yarn.py +++ b/lib/ansible/modules/packaging/language/yarn.py @@ -120,17 +120,17 @@ RETURN = ''' changed: description: Whether Yarn changed any package data returned: always - type: boolean + type: bool sample: true msg: description: Provides an error message if Yarn syntax was incorrect returned: failure - type: string + type: str sample: "Package must be explicitly named when uninstalling." invocation: description: Parameters and values used during execution returned: success - type: dictionary + type: dict sample: { "module_args": { "executable": null, @@ -147,7 +147,7 @@ invocation: out: description: Output generated from Yarn with emojis removed. returned: always - type: string + type: str sample: "yarn add v0.16.1[1/4] Resolving packages...[2/4] Fetching packages...[3/4] Linking dependencies...[4/4] Building fresh packages...success Saved lockfile.success Saved 1 new dependency..left-pad@1.1.3 Done in 0.59s." ''' diff --git a/lib/ansible/modules/packaging/os/apt.py b/lib/ansible/modules/packaging/os/apt.py index 9c84d041b2..3f74945828 100644 --- a/lib/ansible/modules/packaging/os/apt.py +++ b/lib/ansible/modules/packaging/os/apt.py @@ -243,7 +243,7 @@ RETURN = ''' cache_updated: description: if the cache was updated or not returned: success, in some cases - type: boolean + type: bool sample: True cache_update_time: description: time of the last cache update (0 if unknown) @@ -253,12 +253,12 @@ cache_update_time: stdout: description: output from apt returned: success, when needed - type: string + type: str sample: "Reading package lists...\nBuilding dependency tree...\nReading state information...\nThe following extra packages will be installed:\n apache2-bin ..." stderr: description: error output from apt returned: success, when needed - type: string + type: str sample: "AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 127.0.1.1. Set the 'ServerName' directive globally to ..." ''' # NOQA diff --git a/lib/ansible/modules/packaging/os/flatpak.py b/lib/ansible/modules/packaging/os/flatpak.py index 49efc35ee9..409e2f7f81 100644 --- a/lib/ansible/modules/packaging/os/flatpak.py +++ b/lib/ansible/modules/packaging/os/flatpak.py @@ -121,12 +121,12 @@ RETURN = r''' command: description: The exact flatpak command that was executed returned: When a flatpak command has been executed - type: string + type: str sample: "/usr/bin/flatpak install --user -y flathub org.gnome.Calculator" msg: description: Module error message returned: failure - type: string + type: str sample: "Executable '/usr/local/bin/flatpak' was not found on the system." rc: description: Return code from flatpak binary @@ -136,12 +136,12 @@ rc: stderr: description: Error output from flatpak binary returned: When a flatpak command has been executed - type: string + type: str sample: "error: Error searching remote flathub: Can't find ref org.gnome.KDE" stdout: description: Output from flatpak binary returned: When a flatpak command has been executed - type: string + type: str sample: "org.gnome.Calendar/x86_64/stable\tcurrent\norg.gnome.gitg/x86_64/stable\tcurrent\n" ''' diff --git a/lib/ansible/modules/packaging/os/flatpak_remote.py b/lib/ansible/modules/packaging/os/flatpak_remote.py index 508af3c927..e77c41eabb 100644 --- a/lib/ansible/modules/packaging/os/flatpak_remote.py +++ b/lib/ansible/modules/packaging/os/flatpak_remote.py @@ -115,12 +115,12 @@ RETURN = r''' command: description: The exact flatpak command that was executed returned: When a flatpak command has been executed - type: string + type: str sample: "/usr/bin/flatpak remote-add --system flatpak-test https://dl.flathub.org/repo/flathub.flatpakrepo" msg: description: Module error message returned: failure - type: string + type: str sample: "Executable '/usr/local/bin/flatpak' was not found on the system." rc: description: Return code from flatpak binary @@ -130,12 +130,12 @@ rc: stderr: description: Error output from flatpak binary returned: When a flatpak command has been executed - type: string + type: str sample: "error: GPG verification enabled, but no summary found (check that the configured URL in remote config is correct)\n" stdout: description: Output from flatpak binary returned: When a flatpak command has been executed - type: string + type: str sample: "flathub\tFlathub\thttps://dl.flathub.org/repo/\t1\t\n" ''' diff --git a/lib/ansible/modules/packaging/os/pulp_repo.py b/lib/ansible/modules/packaging/os/pulp_repo.py index 5fda31ba31..acd17e9d3f 100644 --- a/lib/ansible/modules/packaging/os/pulp_repo.py +++ b/lib/ansible/modules/packaging/os/pulp_repo.py @@ -188,7 +188,7 @@ RETURN = ''' repo: description: Name of the repo that the action was performed on. returned: success - type: string + type: str sample: my_repo ''' diff --git a/lib/ansible/modules/packaging/os/snap.py b/lib/ansible/modules/packaging/os/snap.py index 19d1611697..f147b19908 100644 --- a/lib/ansible/modules/packaging/os/snap.py +++ b/lib/ansible/modules/packaging/os/snap.py @@ -89,15 +89,15 @@ EXAMPLES = ''' RETURN = ''' classic: description: Whether or not the snaps were installed with the classic confinement - type: boolean + type: bool returned: When snaps are installed channel: description: The channel the snaps were installed from - type: string + type: str returned: When snaps are installed cmd: description: The command that was executed on the host - type: string + type: str returned: When changed is true snaps_installed: description: The list of actually installed snaps diff --git a/lib/ansible/modules/packaging/os/swupd.py b/lib/ansible/modules/packaging/os/swupd.py index 20b26413a5..e2da616ee1 100644 --- a/lib/ansible/modules/packaging/os/swupd.py +++ b/lib/ansible/modules/packaging/os/swupd.py @@ -92,11 +92,11 @@ RETURN = ''' stdout: description: stdout of swupd returned: always - type: string + type: str stderr: description: stderr of swupd returned: always - type: string + type: str ''' import os diff --git a/lib/ansible/modules/packaging/os/xbps.py b/lib/ansible/modules/packaging/os/xbps.py index 272ad9cc4b..bfdef45f30 100644 --- a/lib/ansible/modules/packaging/os/xbps.py +++ b/lib/ansible/modules/packaging/os/xbps.py @@ -72,7 +72,7 @@ RETURN = ''' msg: description: Message about results returned: success - type: string + type: str sample: "System Upgraded" packages: description: Packages that are affected/would be affected diff --git a/lib/ansible/modules/packaging/os/yum_repository.py b/lib/ansible/modules/packaging/os/yum_repository.py index 5a732c1e07..92d1cb7bca 100644 --- a/lib/ansible/modules/packaging/os/yum_repository.py +++ b/lib/ansible/modules/packaging/os/yum_repository.py @@ -373,12 +373,12 @@ RETURN = ''' repo: description: repository name returned: success - type: string + type: str sample: "epel" state: description: state of the target, after execution returned: success - type: string + type: str sample: "present" ''' diff --git a/lib/ansible/modules/remote_management/dellemc/idrac/dellemc_idrac_firmware.py b/lib/ansible/modules/remote_management/dellemc/idrac/dellemc_idrac_firmware.py index 2bee7dba0b..e6cdeb9407 100644 --- a/lib/ansible/modules/remote_management/dellemc/idrac/dellemc_idrac_firmware.py +++ b/lib/ansible/modules/remote_management/dellemc/idrac/dellemc_idrac_firmware.py @@ -102,7 +102,7 @@ EXAMPLES = """ RETURN = """ --- msg: - type: string + type: str description: Over all firmware update status. returned: always sample: "Successfully updated the firmware." diff --git a/lib/ansible/modules/remote_management/hpilo/hpilo_facts.py b/lib/ansible/modules/remote_management/hpilo/hpilo_facts.py index d1fe6e4f28..70b0051c5e 100644 --- a/lib/ansible/modules/remote_management/hpilo/hpilo_facts.py +++ b/lib/ansible/modules/remote_management/hpilo/hpilo_facts.py @@ -69,19 +69,19 @@ RETURN = r''' hw_bios_date: description: BIOS date returned: always - type: string + type: str sample: 05/05/2011 hw_bios_version: description: BIOS version returned: always - type: string + type: str sample: P68 hw_ethX: description: Interface information (for each interface) returned: always - type: dictionary + type: dict sample: - macaddress: 00:11:22:33:44:55 macaddress_dash: 00-11-22-33-44-55 @@ -89,7 +89,7 @@ hw_ethX: hw_eth_ilo: description: Interface information (for the iLO network interface) returned: always - type: dictionary + type: dict sample: - macaddress: 00:11:22:33:44:BA - macaddress_dash: 00-11-22-33-44-BA @@ -97,25 +97,25 @@ hw_eth_ilo: hw_product_name: description: Product name returned: always - type: string + type: str sample: ProLiant DL360 G7 hw_product_uuid: description: Product UUID returned: always - type: string + type: str sample: ef50bac8-2845-40ff-81d9-675315501dac hw_system_serial: description: System serial number returned: always - type: string + type: str sample: ABC12345D6 hw_uuid: description: Hardware UUID returned: always - type: string + type: str sample: 123456ABC78901D2 ''' diff --git a/lib/ansible/modules/remote_management/imc/imc_rest.py b/lib/ansible/modules/remote_management/imc/imc_rest.py index 3cd7ea5103..b8440b322e 100644 --- a/lib/ansible/modules/remote_management/imc/imc_rest.py +++ b/lib/ansible/modules/remote_management/imc/imc_rest.py @@ -210,7 +210,7 @@ elapsed: response: description: HTTP response message, including content length returned: always - type: string + type: str sample: OK (729 bytes) status: description: The HTTP response status code @@ -232,24 +232,24 @@ error: error_code: description: Cisco IMC error code returned: failed - type: string + type: str sample: ERR-xml-parse-error error_text: description: Cisco IMC error message returned: failed - type: string + type: str sample: | XML PARSING ERROR: Element 'computeRackUnit', attribute 'admin_Power': The attribute 'admin_Power' is not allowed. input: description: RAW XML input sent to the Cisco IMC, causing the error returned: failed - type: string + type: str sample: | <configConfMo><inConfig><computeRackUnit dn="sys/rack-unit-1" admin_Power="down"/></inConfig></configConfMo> output: description: RAW XML output eceived from the Cisco IMC, with error details returned: failed - type: string + type: str sample: > <error cookie="" response="yes" diff --git a/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py b/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py index a784e2f45a..8cc8ffc7d0 100644 --- a/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py +++ b/lib/ansible/modules/remote_management/ipmi/ipmi_boot.py @@ -79,7 +79,7 @@ RETURN = ''' bootdev: description: The boot device name which will be used beyond next boot. returned: success - type: string + type: str sample: default persistent: description: If True, system firmware will use this device beyond next boot. diff --git a/lib/ansible/modules/remote_management/ipmi/ipmi_power.py b/lib/ansible/modules/remote_management/ipmi/ipmi_power.py index 7a26b345ef..8dea792ab8 100644 --- a/lib/ansible/modules/remote_management/ipmi/ipmi_power.py +++ b/lib/ansible/modules/remote_management/ipmi/ipmi_power.py @@ -61,7 +61,7 @@ RETURN = ''' powerstate: description: The current power state of the machine. returned: success - type: string + type: str sample: on ''' diff --git a/lib/ansible/modules/remote_management/manageiq/manageiq_group.py b/lib/ansible/modules/remote_management/manageiq/manageiq_group.py index a04d79069a..28c7d67b30 100644 --- a/lib/ansible/modules/remote_management/manageiq/manageiq_group.py +++ b/lib/ansible/modules/remote_management/manageiq/manageiq_group.py @@ -170,7 +170,7 @@ group: description: description: The group description returned: success - type: string + type: str id: description: The group id returned: success @@ -178,15 +178,15 @@ group: group_type: description: The group type, system or user returned: success - type: string + type: str role: description: The group role name returned: success - type: string + type: str tenant: description: The group tenant name returned: success - type: string + type: str managed_filters: description: The tag values per category returned: success @@ -198,7 +198,7 @@ group: created_on: description: Group creation date returned: success - type: string + type: str example: 2018-08-12T08:37:55+00:00 updated_on: description: Group update date diff --git a/lib/ansible/modules/remote_management/manageiq/manageiq_tenant.py b/lib/ansible/modules/remote_management/manageiq/manageiq_tenant.py index ca6892a19c..837150636d 100644 --- a/lib/ansible/modules/remote_management/manageiq/manageiq_tenant.py +++ b/lib/ansible/modules/remote_management/manageiq/manageiq_tenant.py @@ -149,11 +149,11 @@ tenant: name: description: The tenant name returned: success - type: string + type: str description: description: The tenant description returned: success - type: string + type: str parent_id: description: The id of the parent tenant returned: success diff --git a/lib/ansible/modules/remote_management/oneview/oneview_enclosure_facts.py b/lib/ansible/modules/remote_management/oneview/oneview_enclosure_facts.py index d7f195ddc0..a551666584 100644 --- a/lib/ansible/modules/remote_management/oneview/oneview_enclosure_facts.py +++ b/lib/ansible/modules/remote_management/oneview/oneview_enclosure_facts.py @@ -124,7 +124,7 @@ enclosures: enclosure_script: description: Has all the OneView facts about the script of an Enclosure. returned: When requested, but can be null. - type: string + type: str enclosure_environmental_configuration: description: Has all the OneView facts about the environmental configuration of an Enclosure. diff --git a/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py b/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py index 16108bf43d..a61970b7d0 100644 --- a/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py +++ b/lib/ansible/modules/remote_management/redfish/idrac_redfish_command.py @@ -59,7 +59,7 @@ RETURN = ''' msg: description: Message with action result or error description returned: always - type: string + type: str sample: "Action was successful" ''' diff --git a/lib/ansible/modules/remote_management/redfish/redfish_command.py b/lib/ansible/modules/remote_management/redfish/redfish_command.py index 3693c35374..2b9a07aa90 100644 --- a/lib/ansible/modules/remote_management/redfish/redfish_command.py +++ b/lib/ansible/modules/remote_management/redfish/redfish_command.py @@ -134,7 +134,7 @@ RETURN = ''' msg: description: Message with action result or error description returned: always - type: string + type: str sample: "Action was successful" ''' diff --git a/lib/ansible/modules/remote_management/redfish/redfish_config.py b/lib/ansible/modules/remote_management/redfish/redfish_config.py index ad1cff71f5..33d12b97b1 100644 --- a/lib/ansible/modules/remote_management/redfish/redfish_config.py +++ b/lib/ansible/modules/remote_management/redfish/redfish_config.py @@ -145,7 +145,7 @@ RETURN = ''' msg: description: Message with action result or error description returned: always - type: string + type: str sample: "Action was successful" ''' diff --git a/lib/ansible/modules/remote_management/stacki/stacki_host.py b/lib/ansible/modules/remote_management/stacki/stacki_host.py index ec5081d515..987c8a4901 100644 --- a/lib/ansible/modules/remote_management/stacki/stacki_host.py +++ b/lib/ansible/modules/remote_management/stacki/stacki_host.py @@ -79,7 +79,7 @@ RETURN = ''' changed: description: response to whether or not the api call completed successfully returned: always - type: boolean + type: bool sample: true stdout: diff --git a/lib/ansible/modules/source_control/git.py b/lib/ansible/modules/source_control/git.py index dca4ba8247..e50268518b 100644 --- a/lib/ansible/modules/source_control/git.py +++ b/lib/ansible/modules/source_control/git.py @@ -227,32 +227,32 @@ RETURN = ''' after: description: last commit revision of the repository retrieved during the update returned: success - type: string + type: str sample: 4c020102a9cd6fe908c9a4a326a38f972f63a903 before: description: commit revision before the repository was updated, "null" for new repository returned: success - type: string + type: str sample: 67c04ebe40a003bda0efb34eacfb93b0cafdf628 remote_url_changed: description: Contains True or False whether or not the remote URL was changed. returned: success - type: boolean + type: bool sample: True warnings: description: List of warnings if requested features were not available due to a too old git version. returned: error - type: string + type: str sample: Your git version is too old to fully support the depth argument. Falling back to full checkouts. git_dir_now: description: Contains the new path of .git directory if it's changed returned: success - type: string + type: str sample: /path/to/new/git/dir git_dir_before: description: Contains the original path of .git directory if it's changed returned: success - type: string + type: str sample: /path/to/old/git/dir ''' diff --git a/lib/ansible/modules/source_control/git_config.py b/lib/ansible/modules/source_control/git_config.py index 28d0f77d4d..620a885b60 100644 --- a/lib/ansible/modules/source_control/git_config.py +++ b/lib/ansible/modules/source_control/git_config.py @@ -125,13 +125,13 @@ RETURN = ''' config_value: description: When list_all=no and value is not set, a string containing the value of the setting in name returned: success - type: string + type: str sample: "vim" config_values: description: When list_all=yes, a dict containing key/value pairs of multiple configuration settings returned: success - type: dictionary + type: dict sample: core.editor: "vim" color.ui: "auto" diff --git a/lib/ansible/modules/source_control/github_deploy_key.py b/lib/ansible/modules/source_control/github_deploy_key.py index 26a648ab16..7a0b562491 100644 --- a/lib/ansible/modules/source_control/github_deploy_key.py +++ b/lib/ansible/modules/source_control/github_deploy_key.py @@ -129,7 +129,7 @@ RETURN = ''' msg: description: the status message describing what occurred returned: always - type: string + type: str sample: "Deploy key added successfully" http_status_code: @@ -141,7 +141,7 @@ http_status_code: error: description: the error message returned by the GitHub API returned: failed - type: string + type: str sample: "key is already in use" id: diff --git a/lib/ansible/modules/source_control/github_issue.py b/lib/ansible/modules/source_control/github_issue.py index a7135d4e82..5e3e33829a 100644 --- a/lib/ansible/modules/source_control/github_issue.py +++ b/lib/ansible/modules/source_control/github_issue.py @@ -46,7 +46,7 @@ requirements: RETURN = ''' get_status: description: State of the GitHub issue - type: string + type: str returned: success sample: open, closed ''' diff --git a/lib/ansible/modules/source_control/github_release.py b/lib/ansible/modules/source_control/github_release.py index 2804e059d3..0179653072 100644 --- a/lib/ansible/modules/source_control/github_release.py +++ b/lib/ansible/modules/source_control/github_release.py @@ -116,13 +116,13 @@ create_release: - Version of the created release - "For Ansible version 2.5 and later, if specified release version already exists, then State is unchanged" - "For Ansible versions prior to 2.5, if specified release version already exists, then State is skipped" - type: string + type: str returned: success sample: 1.1.0 latest_release: description: Version of the latest release - type: string + type: str returned: success sample: 1.1.0 ''' diff --git a/lib/ansible/modules/source_control/gitlab_deploy_key.py b/lib/ansible/modules/source_control/gitlab_deploy_key.py index eae4ac2fd1..503c321607 100644 --- a/lib/ansible/modules/source_control/gitlab_deploy_key.py +++ b/lib/ansible/modules/source_control/gitlab_deploy_key.py @@ -96,7 +96,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Success" result: @@ -107,7 +107,7 @@ result: error: description: the error message returned by the Gitlab API returned: failed - type: string + type: str sample: "400: key is already in use" previous_version: diff --git a/lib/ansible/modules/source_control/gitlab_hooks.py b/lib/ansible/modules/source_control/gitlab_hooks.py index 07f066577f..b65d39ec31 100644 --- a/lib/ansible/modules/source_control/gitlab_hooks.py +++ b/lib/ansible/modules/source_control/gitlab_hooks.py @@ -148,7 +148,7 @@ RETURN = ''' msg: description: Success or failure message returned: always - type: string + type: str sample: "Success" result: @@ -159,7 +159,7 @@ result: error: description: the error message returned by the Gitlab API returned: failed - type: string + type: str sample: "400: key is already in use" previous_version: diff --git a/lib/ansible/modules/source_control/gitlab_runner.py b/lib/ansible/modules/source_control/gitlab_runner.py index 935a1e96ac..68a30ea4a9 100644 --- a/lib/ansible/modules/source_control/gitlab_runner.py +++ b/lib/ansible/modules/source_control/gitlab_runner.py @@ -138,7 +138,7 @@ RETURN = ''' changed: description: Values changed on the API returned: changed - type: boolean + type: bool sample: false msg: description: Information returned from the API when updating a runner, a create only returns the id and token. diff --git a/lib/ansible/modules/storage/ibm/ibm_sa_domain.py b/lib/ansible/modules/storage/ibm/ibm_sa_domain.py index d24cbadad3..6866ad2e04 100644 --- a/lib/ansible/modules/storage/ibm/ibm_sa_domain.py +++ b/lib/ansible/modules/storage/ibm/ibm_sa_domain.py @@ -104,7 +104,7 @@ RETURN = ''' msg: description: module return status. returned: as needed - type: string + type: str sample: "domain 'domain_name' created successfully." ''' diff --git a/lib/ansible/modules/storage/netapp/_sf_snapshot_schedule_manager.py b/lib/ansible/modules/storage/netapp/_sf_snapshot_schedule_manager.py index dca1f9c198..0301375bec 100644 --- a/lib/ansible/modules/storage/netapp/_sf_snapshot_schedule_manager.py +++ b/lib/ansible/modules/storage/netapp/_sf_snapshot_schedule_manager.py @@ -132,7 +132,7 @@ RETURN = """ schedule_id: description: Schedule ID of the newly created schedule returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/_sf_volume_manager.py b/lib/ansible/modules/storage/netapp/_sf_volume_manager.py index 8a1c936247..16cb4220c3 100644 --- a/lib/ansible/modules/storage/netapp/_sf_volume_manager.py +++ b/lib/ansible/modules/storage/netapp/_sf_volume_manager.py @@ -125,7 +125,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_access_group.py b/lib/ansible/modules/storage/netapp/na_elementsw_access_group.py index 4cc04bd19d..21982f0b23 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_access_group.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_access_group.py @@ -104,7 +104,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_cluster.py b/lib/ansible/modules/storage/netapp/na_elementsw_cluster.py index 2f7a601afd..0b7454e81f 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_cluster.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_cluster.py @@ -94,7 +94,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_drive.py b/lib/ansible/modules/storage/netapp/na_elementsw_drive.py index 588915515f..c7db7895fe 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_drive.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_drive.py @@ -115,7 +115,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_network_interfaces.py b/lib/ansible/modules/storage/netapp/na_elementsw_network_interfaces.py index 87b47c6273..92ea50a12b 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_network_interfaces.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_network_interfaces.py @@ -151,7 +151,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_node.py b/lib/ansible/modules/storage/netapp/na_elementsw_node.py index d6c48614e2..2848750190 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_node.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_node.py @@ -81,7 +81,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot.py b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot.py index 3419b92a53..bf9c95bea7 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot.py @@ -135,7 +135,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_restore.py b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_restore.py index caecb48072..7fa66ee1ea 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_restore.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_restore.py @@ -74,7 +74,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ import traceback diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_schedule.py b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_schedule.py index e22b7b143a..0ad7091e08 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_schedule.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_snapshot_schedule.py @@ -175,7 +175,7 @@ RETURN = """ schedule_id: description: Schedule ID of the newly created schedule returned: success - type: string + type: str """ import traceback from ansible.module_utils.basic import AnsibleModule diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_volume.py b/lib/ansible/modules/storage/netapp/na_elementsw_volume.py index a6f77783a7..6b25cca109 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_volume.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_volume.py @@ -135,7 +135,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ diff --git a/lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py b/lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py index 3622f164ab..c7e23652dc 100644 --- a/lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py +++ b/lib/ansible/modules/storage/netapp/na_elementsw_volume_clone.py @@ -95,7 +95,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str """ diff --git a/lib/ansible/modules/storage/netapp/na_ontap_lun_map.py b/lib/ansible/modules/storage/netapp/na_ontap_lun_map.py index 239e6c825e..b380ceee5f 100644 --- a/lib/ansible/modules/storage/netapp/na_ontap_lun_map.py +++ b/lib/ansible/modules/storage/netapp/na_ontap_lun_map.py @@ -84,27 +84,27 @@ RETURN = """ lun_node: description: NetApp controller that is hosting the LUN. returned: success - type: string + type: str sample: node01 lun_ostype: description: Specifies the OS of the host accessing the LUN. returned: success - type: string + type: str sample: vmware lun_serial: description: A unique, 12-byte, ASCII string used to identify the LUN. returned: success - type: string + type: str sample: 80E7/]LZp1Tt lun_naa_id: description: The Network Address Authority (NAA) identifier for the LUN. returned: success - type: string + type: str sample: 600a0980383045372f5d4c5a70315474 lun_state: description: Online or offline status of the LUN. returned: success - type: string + type: str sample: online lun_size: description: Size of the LUN in bytes. diff --git a/lib/ansible/modules/storage/netapp/na_ontap_nfs.py b/lib/ansible/modules/storage/netapp/na_ontap_nfs.py index e0aa90f6de..ed7697a0ec 100644 --- a/lib/ansible/modules/storage/netapp/na_ontap_nfs.py +++ b/lib/ansible/modules/storage/netapp/na_ontap_nfs.py @@ -254,7 +254,7 @@ class NetAppONTAPNFS(object): :param: name : Name of the vserver :return: status of nfs. None if not found. - :rtype: boolean + :rtype: bool """ nfs_status = netapp_utils.zapi.NaElement('nfs-status') result = self.server.invoke_successfully(nfs_status, True) diff --git a/lib/ansible/modules/storage/netapp/netapp_e_alerts.py b/lib/ansible/modules/storage/netapp/netapp_e_alerts.py index beacc12f13..017a1cfd9b 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_alerts.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_alerts.py @@ -98,7 +98,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The settings have been updated. """ diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg.py b/lib/ansible/modules/storage/netapp/netapp_e_amg.py index 6b40a5e659..54f0353491 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg.py @@ -96,7 +96,7 @@ RETURN = """ msg: description: Successful creation returned: success - type: string + type: str sample: '{"changed": true, "connectionType": "fc", "groupRef": "3700000060080E5000299C24000006E857AC7EEC", "groupState": "optimal", "id": "3700000060080E5000299C24000006E857AC7EEC", "label": "amg_made_by_ansible", "localRole": "primary", "mirrorChannelRemoteTarget": "9000000060080E5000299C24005B06E557AC7EEC", "orphanGroup": false, "recoveryPointAgeAlertThresholdMinutes": 20, "remoteRole": "secondary", "remoteTarget": {"nodeName": {"ioInterfaceType": "fc", "iscsiNodeName": null, "remoteNodeWWN": "20040080E5299F1C"}, "remoteRef": "9000000060080E5000299C24005B06E557AC7EEC", "scsiinitiatorTargetBaseProperties": {"ioInterfaceType": "fc", "iscsiinitiatorTargetBaseParameters": null}}, "remoteTargetId": "ansible2", "remoteTargetName": "Ansible2", "remoteTargetWwn": "60080E5000299F880000000056A25D56", "repositoryUtilizationWarnThreshold": 80, "roleChangeProgress": "none", "syncActivity": "idle", "syncCompletionTimeAlertThresholdMinutes": 10, "syncIntervalMinutes": 10, "worldWideName": "60080E5000299C24000006E857AC7EEC"}' """ # NOQA diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py index 5860a04fa7..a1de1f98ed 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_role.py @@ -78,7 +78,7 @@ RETURN = """ msg: description: Failure message returned: failure - type: string + type: str sample: "No Async Mirror Group with the name." """ import json diff --git a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py index 777282c336..b4f99813b7 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_amg_sync.py @@ -81,7 +81,7 @@ RETURN = """ json: description: The object attributes of the AMG. returned: success - type: string + type: str example: { "changed": false, diff --git a/lib/ansible/modules/storage/netapp/netapp_e_asup.py b/lib/ansible/modules/storage/netapp/netapp_e_asup.py index 6301868e93..a1d0d93681 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_asup.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_asup.py @@ -117,7 +117,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The settings have been updated. asup: description: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_auditlog.py b/lib/ansible/modules/storage/netapp/netapp_e_auditlog.py index 90a942e4c4..7191adc0d5 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_auditlog.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_auditlog.py @@ -96,7 +96,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The settings have been updated. """ diff --git a/lib/ansible/modules/storage/netapp/netapp_e_auth.py b/lib/ansible/modules/storage/netapp/netapp_e_auth.py index a41decbf32..521e2c6b39 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_auth.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_auth.py @@ -83,7 +83,7 @@ RETURN = ''' msg: description: Success message returned: success - type: string + type: str sample: "Password Updated Successfully" ''' import json diff --git a/lib/ansible/modules/storage/netapp/netapp_e_facts.py b/lib/ansible/modules/storage/netapp/netapp_e_facts.py index 8ad6aadba7..7800ac79e6 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_facts.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_facts.py @@ -61,7 +61,7 @@ RETURN = """ msg: description: Gathered facts for <StorageArrayId>. returned: always - type: string + type: str """ import json diff --git a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py index 5ec29578f8..6aba25ab99 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_flashcache.py @@ -85,7 +85,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str sample: json for newly created flash cache """ import json diff --git a/lib/ansible/modules/storage/netapp/netapp_e_global.py b/lib/ansible/modules/storage/netapp/netapp_e_global.py index a70820c2a0..04d71e8e78 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_global.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_global.py @@ -51,7 +51,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The settings have been updated. name: description: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_host.py b/lib/ansible/modules/storage/netapp/netapp_e_host.py index 54e498af25..30aa65779b 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_host.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_host.py @@ -128,13 +128,13 @@ msg: description: - A user-readable description of the actions performed. returned: on success - type: string + type: str sample: The host has been created. id: description: - the unique identifier of the host on the E-Series storage-system returned: on success when state=present - type: string + type: str sample: 00000000600A098000AAC0C3003004700AD86A52 version_added: "2.6" @@ -142,7 +142,7 @@ ssid: description: - the unique identifer of the E-Series storage-system with the current api returned: on success - type: string + type: str sample: 1 version_added: "2.6" @@ -150,7 +150,7 @@ api_url: description: - the url of the API that this request was proccessed by returned: on success - type: string + type: str sample: https://webservices.example.com:8443 version_added: "2.6" diff --git a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py index 370417ea43..3c1f330c2e 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_hostgroup.py @@ -79,13 +79,13 @@ RETURN = ''' clusterRef: description: The unique identification value for this object. Other objects may use this reference value to refer to the cluster. returned: always except when state is absent - type: string + type: str sample: "3233343536373839303132333100000000000000" confirmLUNMappingCreation: description: If true, indicates that creation of LUN-to-volume mappings should require careful confirmation from the end-user, since such a mapping will alter the volume access rights of other clusters, in addition to this one. returned: always - type: boolean + type: bool sample: false hosts: description: A list of the hosts that are part of the host group after all operations. @@ -95,28 +95,28 @@ hosts: id: description: The id number of the hostgroup returned: always except when state is absent - type: string + type: str sample: "3233343536373839303132333100000000000000" isSAControlled: description: If true, indicates that I/O accesses from this cluster are subject to the storage array's default LUN-to-volume mappings. If false, indicates that I/O accesses from the cluster are subject to cluster-specific LUN-to-volume mappings. returned: always except when state is absent - type: boolean + type: bool sample: false label: description: The user-assigned, descriptive label string for the cluster. returned: always - type: string + type: str sample: "MyHostGroup" name: description: same as label returned: always except when state is absent - type: string + type: str sample: "MyHostGroup" protectionInformationCapableAccessMethod: description: This field is true if the host has a PI capable access method. returned: always except when state is absent - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_iscsi_interface.py b/lib/ansible/modules/storage/netapp/netapp_e_iscsi_interface.py index 31a2c0a5d6..de9c357e81 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_iscsi_interface.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_iscsi_interface.py @@ -143,7 +143,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The interface settings have been updated. enabled: description: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_iscsi_target.py b/lib/ansible/modules/storage/netapp/netapp_e_iscsi_target.py index ad4975e5eb..ec7116ed6e 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_iscsi_target.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_iscsi_target.py @@ -87,20 +87,20 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The iSCSI target settings have been updated. alias: description: - The alias assigned to the iSCSI target. returned: on success sample: myArray - type: string + type: str iqn: description: - The iqn (iSCSI Qualified Name), assigned to the iSCSI target. returned: on success sample: iqn.1992-08.com.netapp:2800.000a132000b006d2000000005a0e8f45 - type: string + type: str """ import json import logging diff --git a/lib/ansible/modules/storage/netapp/netapp_e_ldap.py b/lib/ansible/modules/storage/netapp/netapp_e_ldap.py index c0d89cb7d9..f2dbc54e7f 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_ldap.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_ldap.py @@ -142,7 +142,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The ldap settings have been updated. """ diff --git a/lib/ansible/modules/storage/netapp/netapp_e_lun_mapping.py b/lib/ansible/modules/storage/netapp/netapp_e_lun_mapping.py index 0e1510ddee..576718a442 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_lun_mapping.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_lun_mapping.py @@ -86,7 +86,7 @@ RETURN = ''' msg: description: success of the module returned: always - type: string + type: str sample: Lun mapping is complete ''' import json diff --git a/lib/ansible/modules/storage/netapp/netapp_e_mgmt_interface.py b/lib/ansible/modules/storage/netapp/netapp_e_mgmt_interface.py index c6ed82c7e0..594479ab03 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_mgmt_interface.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_mgmt_interface.py @@ -213,7 +213,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The interface settings have been updated. enabled: description: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py index e1f16aed27..0b678fe818 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_group.py @@ -125,7 +125,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str sample: json facts for newly created snapshot group. """ HEADERS = { diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py index c9e35f9dee..5e179390d0 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_images.py @@ -65,12 +65,12 @@ RETURN = """ --- msg: description: State of operation - type: string + type: str returned: always sample: "Created snapshot image" image_id: description: ID of snaphot image - type: string + type: str returned: state == created sample: "3400000060080E5000299B640063074057BC5C5E " """ diff --git a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py index d4cf471afc..38e9fa89c0 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_snapshot_volume.py @@ -100,7 +100,7 @@ RETURN = """ msg: description: Success message returned: success - type: string + type: str sample: Json facts for the volume that was created. """ HEADERS = { diff --git a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py index cd1ac979e1..a2f6ad1149 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storage_system.py @@ -87,7 +87,7 @@ EXAMPLES = ''' RETURN = ''' msg: description: State of request - type: string + type: str returned: always sample: 'Storage system removed.' ''' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py index 4f7f29612b..0cd3029749 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_storagepool.py @@ -101,7 +101,7 @@ RETURN = ''' msg: description: Success message returned: success - type: string + type: str sample: Json facts for the pool that was created. ''' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_syslog.py b/lib/ansible/modules/storage/netapp/netapp_e_syslog.py index 8e9d444ee9..fc4dae833d 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_syslog.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_syslog.py @@ -89,7 +89,7 @@ RETURN = """ msg: description: Success message returned: on success - type: string + type: str sample: The settings have been updated. syslog: description: diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume.py b/lib/ansible/modules/storage/netapp/netapp_e_volume.py index 2468b710cb..4d3e42c1ea 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume.py @@ -106,7 +106,7 @@ RETURN = ''' --- msg: description: State of volume - type: string + type: str returned: always sample: "Standard volume [workload_vol_1] has been created." ''' diff --git a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py index 73c64866e0..3f86197baf 100644 --- a/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py +++ b/lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py @@ -84,14 +84,14 @@ EXAMPLES = """ msg: description: Success message returned: success - type: string + type: str sample: Json facts for the volume copy that was created. """ RETURN = """ msg: description: Success message returned: success - type: string + type: str sample: Created Volume Copy Pair with ID """ diff --git a/lib/ansible/modules/storage/zfs/zfs_facts.py b/lib/ansible/modules/storage/zfs/zfs_facts.py index c1882bac4a..354e6fa8ae 100644 --- a/lib/ansible/modules/storage/zfs/zfs_facts.py +++ b/lib/ansible/modules/storage/zfs/zfs_facts.py @@ -76,22 +76,22 @@ RETURN = ''' name: description: ZFS dataset name returned: always - type: string + type: str sample: rpool/var/spool parsable: description: if parsable output should be provided in machine friendly format. returned: if 'parsable' is set to True - type: boolean + type: bool sample: True recurse: description: if we should recurse over ZFS dataset returned: if 'recurse' is set to True - type: boolean + type: bool sample: True zfs_datasets: description: ZFS dataset facts returned: always - type: string + type: str sample: { "aclinherit": "restricted", diff --git a/lib/ansible/modules/storage/zfs/zpool_facts.py b/lib/ansible/modules/storage/zfs/zpool_facts.py index 5fdc9b74e6..9a577badc6 100644 --- a/lib/ansible/modules/storage/zfs/zpool_facts.py +++ b/lib/ansible/modules/storage/zfs/zpool_facts.py @@ -63,7 +63,7 @@ ansible_facts: ansible_zfs_pools: description: ZFS pool facts returned: always - type: string + type: str sample: { "allocated": "3.46G", @@ -109,12 +109,12 @@ ansible_facts: name: description: ZFS pool name returned: always - type: string + type: str sample: rpool parsable: description: if parsable output should be provided in machine friendly format. returned: if 'parsable' is set to True - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/system/aix_inittab.py b/lib/ansible/modules/system/aix_inittab.py index acf1fd657a..b9efdc1ef7 100644 --- a/lib/ansible/modules/system/aix_inittab.py +++ b/lib/ansible/modules/system/aix_inittab.py @@ -103,17 +103,17 @@ RETURN = ''' name: description: name of the adjusted inittab entry returned: always - type: string + type: str sample: startmyservice msg: description: action done with the inittab entry returned: changed - type: string + type: str sample: changed inittab entry startmyservice changed: description: whether the inittab changed or not returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/system/aix_lvol.py b/lib/ansible/modules/system/aix_lvol.py index ebadd81665..01bcae21ff 100644 --- a/lib/ansible/modules/system/aix_lvol.py +++ b/lib/ansible/modules/system/aix_lvol.py @@ -111,7 +111,7 @@ EXAMPLES = r''' RETURN = r''' msg: - type: string + type: str description: A friendly message describing the task result. returned: always sample: Logical volume testlv created. diff --git a/lib/ansible/modules/system/authorized_key.py b/lib/ansible/modules/system/authorized_key.py index 1626a5127d..3df600161a 100644 --- a/lib/ansible/modules/system/authorized_key.py +++ b/lib/ansible/modules/system/authorized_key.py @@ -151,52 +151,52 @@ RETURN = ''' exclusive: description: If the key has been forced to be exclusive or not. returned: success - type: boolean + type: bool sample: False key: description: The key that the module was running against. returned: success - type: string + type: str sample: https://github.com/user.keys key_option: description: Key options related to the key. returned: success - type: string + type: str sample: null keyfile: description: Path for authorized key file. returned: success - type: string + type: str sample: /home/user/.ssh/authorized_keys manage_dir: description: Whether this module managed the directory of the authorized key file. returned: success - type: boolean + type: bool sample: True path: description: Alternate path to the authorized_keys file returned: success - type: string + type: str sample: null state: description: Whether the given key (with the given key_options) should or should not be in the file returned: success - type: string + type: str sample: present unique: description: Whether the key is unique returned: success - type: boolean + type: bool sample: false user: description: The username on the remote host whose authorized_keys file will be modified returned: success - type: string + type: str sample: user validate_certs: description: This only applies if using a https url as the source of the keys. If set to C(no), the SSL certificates will not be validated. returned: success - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/system/beadm.py b/lib/ansible/modules/system/beadm.py index d7cb03f4df..1dd474f1dc 100644 --- a/lib/ansible/modules/system/beadm.py +++ b/lib/ansible/modules/system/beadm.py @@ -111,37 +111,37 @@ RETURN = ''' name: description: BE name returned: always - type: string + type: str sample: pre-upgrade snapshot: description: ZFS snapshot to create BE from returned: always - type: string + type: str sample: rpool/ROOT/oi-hipster@fresh description: description: BE description returned: always - type: string + type: str sample: Upgrade from 9.0 to 10.0 options: description: BE additional options returned: always - type: string + type: str sample: compression=on mountpoint: description: BE mountpoint returned: always - type: string + type: str sample: /mnt/be state: description: state of the target returned: always - type: string + type: str sample: present force: description: if forced action is wanted returned: always - type: boolean + type: bool sample: False ''' diff --git a/lib/ansible/modules/system/dconf.py b/lib/ansible/modules/system/dconf.py index c5cda633d7..1f266706de 100644 --- a/lib/ansible/modules/system/dconf.py +++ b/lib/ansible/modules/system/dconf.py @@ -71,7 +71,7 @@ RETURN = """ value: description: value associated with the requested key returned: success, state was "read" - type: string + type: str sample: "'Default'" """ diff --git a/lib/ansible/modules/system/gconftool2.py b/lib/ansible/modules/system/gconftool2.py index a189e178c8..3597ee17ce 100644 --- a/lib/ansible/modules/system/gconftool2.py +++ b/lib/ansible/modules/system/gconftool2.py @@ -66,17 +66,17 @@ RETURN = ''' key: description: The key specified in the module parameters returned: success - type: string + type: str sample: /desktop/gnome/interface/font_name value_type: description: The type of the value that was changed returned: success - type: string + type: str sample: string value: description: The value of the preference key after executing the module returned: success - type: string + type: str sample: "Serif 12" ... ''' diff --git a/lib/ansible/modules/system/interfaces_file.py b/lib/ansible/modules/system/interfaces_file.py index d579c1eb29..ed1ce6d8fb 100644 --- a/lib/ansible/modules/system/interfaces_file.py +++ b/lib/ansible/modules/system/interfaces_file.py @@ -65,7 +65,7 @@ RETURN = ''' dest: description: destination file/path returned: success - type: string + type: str sample: "/etc/network/interfaces" ifaces: description: interfaces dictionary @@ -75,27 +75,27 @@ ifaces: ifaces: description: interface dictionary returned: success - type: dictionary + type: dict contains: eth0: description: Name of the interface returned: success - type: dictionary + type: dict contains: address_family: description: interface address family returned: success - type: string + type: str sample: "inet" method: description: interface method returned: success - type: string + type: str sample: "manual" mtu: description: other options, all values returned as strings returned: success - type: string + type: str sample: "1500" pre-up: description: list of C(pre-up) scripts diff --git a/lib/ansible/modules/system/java_cert.py b/lib/ansible/modules/system/java_cert.py index 11a3b46c66..bafe6c1436 100644 --- a/lib/ansible/modules/system/java_cert.py +++ b/lib/ansible/modules/system/java_cert.py @@ -110,7 +110,7 @@ RETURN = ''' msg: description: Output from stdout of keytool command after execution of given command. returned: success - type: string + type: str sample: "Module require existing keystore at keystore_path '/tmp/test/cacerts'" rc: @@ -122,7 +122,7 @@ rc: cmd: description: Executed command to get action done returned: success - type: string + type: str sample: "keytool -importcert -noprompt -keystore" ''' diff --git a/lib/ansible/modules/system/java_keystore.py b/lib/ansible/modules/system/java_keystore.py index effac2ce74..a8b90ba5bd 100644 --- a/lib/ansible/modules/system/java_keystore.py +++ b/lib/ansible/modules/system/java_keystore.py @@ -93,7 +93,7 @@ RETURN = ''' msg: description: Output from stdout of keytool/openssl command after execution of given command or an error. returned: changed and failure - type: string + type: str sample: "Unable to find the current certificate fingerprint in ..." rc: @@ -105,7 +105,7 @@ rc: cmd: description: Executed command to get action done returned: changed and failure - type: string + type: str sample: "openssl x509 -noout -in /tmp/cert.crt -fingerprint -sha1" ''' diff --git a/lib/ansible/modules/system/known_hosts.py b/lib/ansible/modules/system/known_hosts.py index 57f32e246c..094fa48015 100644 --- a/lib/ansible/modules/system/known_hosts.py +++ b/lib/ansible/modules/system/known_hosts.py @@ -1,6 +1,6 @@ #!/usr/bin/python -# Copyright(c) 2014, Matthew Vernon <mcv21@cam.ac.uk> +# Copyright: (c) 2014, Matthew Vernon <mcv21@cam.ac.uk> # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function @@ -75,16 +75,17 @@ EXAMPLES = ''' # state = absent|present (default: present) import base64 +import errno import hashlib import hmac import os import os.path -import tempfile -import errno import re +import tempfile -from ansible.module_utils._text import to_bytes, to_native from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.common.file import FileLock +from ansible.module_utils._text import to_bytes, to_native def enforce_state(module, params): diff --git a/lib/ansible/modules/system/mksysb.py b/lib/ansible/modules/system/mksysb.py index 2306d9ca95..7ac43e28ac 100644 --- a/lib/ansible/modules/system/mksysb.py +++ b/lib/ansible/modules/system/mksysb.py @@ -93,12 +93,12 @@ RETURN = ''' changed: description: Return changed for mksysb actions as true or false. returned: always - type: boolean + type: bool version_added: 2.5 msg: description: Return message regarding the action. returned: always - type: string + type: str version_added: 2.5 ''' diff --git a/lib/ansible/modules/system/nosh.py b/lib/ansible/modules/system/nosh.py index 2a728f220b..72d2cc7366 100644 --- a/lib/ansible/modules/system/nosh.py +++ b/lib/ansible/modules/system/nosh.py @@ -109,27 +109,27 @@ RETURN = ''' name: description: name used to find the service returned: success - type: string + type: str sample: "sshd" service_path: description: resolved path for the service returned: success - type: string + type: str sample: "/var/sv/sshd" enabled: description: whether the service is enabled at system bootstrap returned: success - type: boolean + type: bool sample: True preset: description: whether the enabled status reflects the one set in the relevant C(*.preset) file returned: success - type: boolean + type: bool sample: False state: description: service process run state, C(None) if the service is not loaded and will not be started returned: if state option is used - type: string + type: str sample: "reloaded" status: description: a dictionary with the key=value pairs returned by `system-control show-json` or C(None) if the service is not loaded @@ -188,7 +188,7 @@ status: user: description: whether the user-level service manager is called returned: success - type: boolean + type: bool sample: False ''' diff --git a/lib/ansible/modules/system/osx_defaults.py b/lib/ansible/modules/system/osx_defaults.py index 24281ac312..e0c63adacf 100644 --- a/lib/ansible/modules/system/osx_defaults.py +++ b/lib/ansible/modules/system/osx_defaults.py @@ -70,7 +70,7 @@ EXAMPLES = ''' - osx_defaults: domain: NSGlobalDomain key: AppleMeasurementUnits - type: string + type: str value: Centimeters state: present @@ -83,7 +83,7 @@ EXAMPLES = ''' - osx_defaults: key: AppleMeasurementUnits - type: string + type: str value: Centimeters - osx_defaults: diff --git a/lib/ansible/modules/system/pamd.py b/lib/ansible/modules/system/pamd.py index cb3dfcae07..5ed000562e 100644 --- a/lib/ansible/modules/system/pamd.py +++ b/lib/ansible/modules/system/pamd.py @@ -231,14 +231,14 @@ change_count: version_added: 2.4 new_rule: description: The changes to the rule. This was available in Ansible version 2.4 and 2.5. It was removed in 2.6. - type: string + type: str sample: None None None sha512 shadow try_first_pass use_authtok returned: success version_added: 2.4 updated_rule_(n): description: The rule(s) that was/were changed. This is only available in Ansible version 2.4 and was removed in 2.5. - type: string + type: str sample: - password sufficient pam_unix.so sha512 shadow try_first_pass use_authtok @@ -250,7 +250,7 @@ action: insert_before_rule, insert_after_rule, args_present, args_absent, absent. This was available in Ansible version 2.4 and removed in 2.8" returned: always - type: string + type: str sample: "update_rule" version_added: 2.4 dest: @@ -258,13 +258,13 @@ dest: - "Path to pam.d service that was changed. This is only available in Ansible version 2.3 and was removed in 2.4." returned: success - type: string + type: str sample: "/etc/pam.d/system-auth" backupdest: description: - "The file name of the backup file, if created." returned: success - type: string + type: str version_added: 2.6 ... ''' diff --git a/lib/ansible/modules/system/ping.py b/lib/ansible/modules/system/ping.py index 0d0e2fd107..715be21433 100644 --- a/lib/ansible/modules/system/ping.py +++ b/lib/ansible/modules/system/ping.py @@ -58,7 +58,7 @@ RETURN = ''' ping: description: value provided with the data parameter returned: success - type: string + type: str sample: pong ''' diff --git a/lib/ansible/modules/system/reboot.py b/lib/ansible/modules/system/reboot.py index 67be8f282d..ff4d4086f0 100644 --- a/lib/ansible/modules/system/reboot.py +++ b/lib/ansible/modules/system/reboot.py @@ -75,7 +75,7 @@ RETURN = r''' rebooted: description: true if the machine was rebooted returned: always - type: boolean + type: bool sample: true elapsed: description: The number of seconds that elapsed waiting for the system to be rebooted. diff --git a/lib/ansible/modules/system/selinux.py b/lib/ansible/modules/system/selinux.py index 897596c152..79f4ed3072 100644 --- a/lib/ansible/modules/system/selinux.py +++ b/lib/ansible/modules/system/selinux.py @@ -62,22 +62,22 @@ RETURN = ''' msg: description: Messages that describe changes that were made returned: always - type: string + type: str sample: Config SELinux state changed from 'disabled' to 'permissive' configfile: description: Path to SELinux configuration file returned: always - type: string + type: str sample: /etc/selinux/config policy: description: Name of the SELinux policy returned: always - type: string + type: str sample: targeted state: description: SELinux mode returned: always - type: string + type: str sample: enforcing reboot_required: description: Whether or not an reboot is required for the changes to take effect diff --git a/lib/ansible/modules/system/service_facts.py b/lib/ansible/modules/system/service_facts.py index fc6e5225a3..d5d53165a5 100644 --- a/lib/ansible/modules/system/service_facts.py +++ b/lib/ansible/modules/system/service_facts.py @@ -58,17 +58,17 @@ ansible_facts: source: description: Init system of the service. One of C(systemd), C(sysv), C(upstart). returned: always - type: string + type: str sample: sysv state: description: State of the service. Either C(running) or C(stopped). returned: always - type: string + type: str sample: running name: description: Name of the service. returned: always - type: string + type: str sample: arp-ethers.service ''' diff --git a/lib/ansible/modules/system/user.py b/lib/ansible/modules/system/user.py index 5d6aaad121..7d5069e649 100644 --- a/lib/ansible/modules/system/user.py +++ b/lib/ansible/modules/system/user.py @@ -282,7 +282,7 @@ append: comment: description: Comment section from passwd file, usually the user name returned: When user exists - type: string + type: str sample: Agent Smith create_home: description: Whether or not to create the home directory @@ -302,12 +302,12 @@ group: groups: description: List of groups of which the user is a member returned: When C(groups) is not empty and C(state) is 'present' - type: string + type: str sample: 'chrony,apache' home: description: "Path to user's home directory" returned: When C(state) is 'present' - type: string + type: str sample: '/home/asmith' move_home: description: Whether or not to move an existing home directory @@ -317,12 +317,12 @@ move_home: name: description: User account name returned: always - type: string + type: str sample: asmith password: description: Masked value of the password returned: When C(state) is 'present' and C(password) is not empty - type: string + type: str sample: 'NOT_LOGGING_PASSWORD' remove: description: Whether or not to remove the user account @@ -332,22 +332,22 @@ remove: shell: description: User login shell returned: When C(state) is 'present' - type: string + type: str sample: '/bin/bash' ssh_fingerprint: description: Fingerprint of generated SSH key returned: When C(generate_ssh_key) is C(True) - type: string + type: str sample: '2048 SHA256:aYNHYcyVm87Igh0IMEDMbvW0QDlRQfE0aJugp684ko8 ansible-generated on host (RSA)' ssh_key_file: description: Path to generated SSH public key file returned: When C(generate_ssh_key) is C(True) - type: string + type: str sample: /home/asmith/.ssh/id_rsa ssh_public_key: description: Generated SSH public key file returned: When C(generate_ssh_key) is C(True) - type: string + type: str sample: > 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC95opt4SPEC06tOYsJQJIuN23BbLMGmYo8ysVZQc4h2DZE9ugbjWWGS1/pweUGjVstgzMkBEeBCByaEf/RJKNecKRPeGd2Bw9DCj/bn5Z6rGfNENKBmo 618mUJBvdlEgea96QGjOwSB7/gmonduC7gsWDMNcOdSE3wJMTim4lddiBx4RgC9yXsJ6Tkz9BHD73MXPpT5ETnse+A3fw3IGVSjaueVnlUyUmOBf7fzmZbhlFVXf2Zi2rFTXqvbdGHKkzpw1U8eB8xFPP7y @@ -355,12 +355,12 @@ ssh_public_key: stderr: description: Standard error from running commands returned: When stderr is returned by a command that is run - type: string + type: str sample: Group wheels does not exist stdout: description: Standard output from running commands returned: When standard output is returned by the command that is run - type: string + type: str sample: system: description: Whether or not the account is a system account diff --git a/lib/ansible/modules/system/xfconf.py b/lib/ansible/modules/system/xfconf.py index 66c44ba0e4..4d7a940bb5 100644 --- a/lib/ansible/modules/system/xfconf.py +++ b/lib/ansible/modules/system/xfconf.py @@ -66,22 +66,22 @@ RETURN = ''' channel: description: The channel specified in the module parameters returned: success - type: string + type: str sample: "xsettings" property: description: The property specified in the module parameters returned: success - type: string + type: str sample: "/Xft/DPI" value_type: description: The type of the value that was changed returned: success - type: string + type: str sample: "int" value: description: The value of the preference key after executing the module returned: success - type: string + type: str sample: "192" ... ''' diff --git a/lib/ansible/modules/utilities/logic/pause.py b/lib/ansible/modules/utilities/logic/pause.py index c70305715f..8cc9dd5edd 100644 --- a/lib/ansible/modules/utilities/logic/pause.py +++ b/lib/ansible/modules/utilities/logic/pause.py @@ -70,27 +70,27 @@ RETURN = ''' user_input: description: User input from interactive console returned: if no waiting time set - type: string + type: str sample: Example user input start: description: Time when started pausing returned: always - type: string + type: str sample: "2017-02-23 14:35:07.298862" stop: description: Time when ended pausing returned: always - type: string + type: str sample: "2017-02-23 14:35:09.552594" delta: description: Time paused in seconds returned: always - type: string + type: str sample: 2 stdout: description: Output of pause module returned: always - type: string + type: str sample: Paused for 0.04 minutes echo: description: Value of echo setting diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py index acbc92f906..51258a31de 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_cancel.py @@ -50,7 +50,7 @@ id: status: description: status of the cancel request returned: success - type: string + type: str sample: canceled ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py index 4f5f7d6cb9..cb997abdb2 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_launch.py @@ -78,7 +78,7 @@ id: status: description: status of newly launched job returned: success - type: string + type: str sample: pending ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py index c794454f17..519adc8403 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_job_wait.py @@ -67,17 +67,17 @@ elapsed: started: description: timestamp of when the job started running returned: success - type: string + type: str sample: "2017-03-01T17:03:53.200234Z" finished: description: timestamp of when the job finished running returned: success - type: string + type: str sample: "2017-03-01T17:04:04.078782Z" status: description: current status of job returned: success - type: string + type: str sample: successful ''' diff --git a/lib/ansible/modules/web_infrastructure/apache2_module.py b/lib/ansible/modules/web_infrastructure/apache2_module.py index c09fafc55a..c5e76fd98d 100644 --- a/lib/ansible/modules/web_infrastructure/apache2_module.py +++ b/lib/ansible/modules/web_infrastructure/apache2_module.py @@ -87,7 +87,7 @@ RETURN = ''' result: description: message about action taken returned: always - type: string + type: str warnings: description: list of warning messages returned: when needed @@ -99,11 +99,11 @@ rc: stdout: description: stdout of underlying command returned: failed - type: string + type: str stderr: description: stderr of underlying command returned: failed - type: string + type: str ''' import re diff --git a/lib/ansible/modules/web_infrastructure/gunicorn.py b/lib/ansible/modules/web_infrastructure/gunicorn.py index f6a829dc40..20d5b21d72 100644 --- a/lib/ansible/modules/web_infrastructure/gunicorn.py +++ b/lib/ansible/modules/web_infrastructure/gunicorn.py @@ -92,7 +92,7 @@ RETURN = ''' gunicorn: description: process id of gunicorn returned: changed - type: string + type: str sample: "1234" ''' diff --git a/lib/ansible/modules/web_infrastructure/jenkins_job.py b/lib/ansible/modules/web_infrastructure/jenkins_job.py index bffe470e20..1bd7f3106c 100644 --- a/lib/ansible/modules/web_infrastructure/jenkins_job.py +++ b/lib/ansible/modules/web_infrastructure/jenkins_job.py @@ -122,12 +122,12 @@ RETURN = ''' name: description: Name of the jenkins job. returned: success - type: string + type: str sample: test-job state: description: State of the jenkins job. returned: success - type: string + type: str sample: present enabled: description: Whether the jenkins job is enabled or not. @@ -137,12 +137,12 @@ enabled: user: description: User used for authentication. returned: success - type: string + type: str sample: admin url: description: Url to connect to the Jenkins server. returned: success - type: string + type: str sample: https://jenkins.mydomain.com ''' diff --git a/lib/ansible/modules/web_infrastructure/jenkins_plugin.py b/lib/ansible/modules/web_infrastructure/jenkins_plugin.py index 335835162a..27234573bc 100644 --- a/lib/ansible/modules/web_infrastructure/jenkins_plugin.py +++ b/lib/ansible/modules/web_infrastructure/jenkins_plugin.py @@ -252,12 +252,12 @@ RETURN = ''' plugin: description: plugin name returned: success - type: string + type: str sample: build-pipeline-plugin state: description: state of the target, after execution returned: success - type: string + type: str sample: "present" ''' diff --git a/lib/ansible/modules/web_infrastructure/jenkins_script.py b/lib/ansible/modules/web_infrastructure/jenkins_script.py index ea34edf4eb..5e8b7ffadb 100644 --- a/lib/ansible/modules/web_infrastructure/jenkins_script.py +++ b/lib/ansible/modules/web_infrastructure/jenkins_script.py @@ -98,7 +98,7 @@ RETURN = ''' output: description: Result of script returned: success - type: string + type: str sample: 'Result: true' ''' diff --git a/lib/ansible/modules/web_infrastructure/nginx_status_facts.py b/lib/ansible/modules/web_infrastructure/nginx_status_facts.py index d43e735b03..5a7e44c863 100644 --- a/lib/ansible/modules/web_infrastructure/nginx_status_facts.py +++ b/lib/ansible/modules/web_infrastructure/nginx_status_facts.py @@ -89,7 +89,7 @@ nginx_status_facts.waiting: nginx_status_facts.data: description: HTTP response as is. returned: success - type: string + type: str sample: "Active connections: 2340 \nserver accepts handled requests\n 81769947 81769947 144332345 \nReading: 0 Writing: 241 Waiting: 2092 \n" ''' diff --git a/lib/ansible/modules/web_infrastructure/rundeck_acl_policy.py b/lib/ansible/modules/web_infrastructure/rundeck_acl_policy.py index 70f79df3ab..ad855e1309 100644 --- a/lib/ansible/modules/web_infrastructure/rundeck_acl_policy.py +++ b/lib/ansible/modules/web_infrastructure/rundeck_acl_policy.py @@ -88,7 +88,7 @@ RETURN = ''' rundeck_response: description: Rundeck response when a failure occurs. returned: failed - type: string + type: str before: description: dictionnary containing ACL policy informations before modification. returned: success diff --git a/lib/ansible/modules/web_infrastructure/rundeck_project.py b/lib/ansible/modules/web_infrastructure/rundeck_project.py index a194173b93..a56dc1210c 100644 --- a/lib/ansible/modules/web_infrastructure/rundeck_project.py +++ b/lib/ansible/modules/web_infrastructure/rundeck_project.py @@ -71,7 +71,7 @@ RETURN = ''' rundeck_response: description: Rundeck response when a failure occurs returned: failed - type: string + type: str before: description: dictionnary containing project informations before modification returned: success diff --git a/lib/ansible/modules/web_infrastructure/sophos_utm/utm_dns_host.py b/lib/ansible/modules/web_infrastructure/sophos_utm/utm_dns_host.py index f5d479df99..d49d4c61a7 100644 --- a/lib/ansible/modules/web_infrastructure/sophos_utm/utm_dns_host.py +++ b/lib/ansible/modules/web_infrastructure/sophos_utm/utm_dns_host.py @@ -93,34 +93,34 @@ result: contains: _ref: description: The reference name of the object - type: string + type: str _locked: description: Whether or not the object is currently locked - type: boolean + type: bool name: description: The name of the object - type: string + type: str address: description: The ipv4 address of the object - type: string + type: str address6: description: The ipv6 adress of the object - type: string + type: str comment: description: The comment string - type: string + type: str hostname: description: The hostname of the object - type: string + type: str interface: description: The reference name of the interface the object is associated with - type: string + type: str resolved: description: Whether the ipv4 address is resolved or not - type: boolean + type: bool resolved6: description: Whether the ipv6 address is resolved or not - type: boolean + type: bool timeout: description: The timeout until a new resolving will be attempted type: int diff --git a/lib/ansible/modules/windows/win_audit_policy_system.py b/lib/ansible/modules/windows/win_audit_policy_system.py index 7e3e7c9162..331792cb73 100644 --- a/lib/ansible/modules/windows/win_audit_policy_system.py +++ b/lib/ansible/modules/windows/win_audit_policy_system.py @@ -63,7 +63,7 @@ RETURN = ''' current_audit_policy: description: details on the policy being targetted returned: always - type: dictionary + type: dict sample: |- { "File Share":"failure" diff --git a/lib/ansible/modules/windows/win_audit_rule.py b/lib/ansible/modules/windows/win_audit_rule.py index 6e7555cab6..9665b4b25d 100644 --- a/lib/ansible/modules/windows/win_audit_rule.py +++ b/lib/ansible/modules/windows/win_audit_rule.py @@ -121,7 +121,7 @@ current_audit_rules: - The current rules on the defined I(path) - Will return "No audit rules defined on I(path)" returned: always - type: dictionary + type: dict sample: | { "audit_flags": "Success", @@ -136,5 +136,5 @@ path_type: - The type of I(path) being targetted. - Will be one of file, directory, registry. returned: always - type: string + type: str ''' diff --git a/lib/ansible/modules/windows/win_chocolatey_facts.py b/lib/ansible/modules/windows/win_chocolatey_facts.py index 07641870d3..0e9ae2b6b7 100644 --- a/lib/ansible/modules/windows/win_chocolatey_facts.py +++ b/lib/ansible/modules/windows/win_chocolatey_facts.py @@ -99,7 +99,7 @@ ansible_facts: certificate: description: Pth to a PFX certificate for X509 authenticated feeds returned: always - type: string + type: str sample: C:\chocolatey\cert.pfx disabled: description: Is the source disabled @@ -109,7 +109,7 @@ ansible_facts: name: description: Name of the source returned: always - type: string + type: str sample: chocolatey priority: description: The priority order of this source, lower is better, 0 is no priority @@ -119,12 +119,12 @@ ansible_facts: source: description: The source, can be a folder/file or an url returned: always - type: string + type: str sample: https://chocolatey.org/api/v2/ source_username: description: Username used to access authenticated feeds returned: always - type: string + type: str sample: username packages: description: List of installed Packages @@ -134,11 +134,11 @@ ansible_facts: package: description: Name of the package returned: always - type: string + type: str sample: vscode version: description: Version of the package returned: always - type: string + type: str sample: '1.27.2' ''' diff --git a/lib/ansible/modules/windows/win_command.py b/lib/ansible/modules/windows/win_command.py index 9873b4f349..17d7fcd373 100644 --- a/lib/ansible/modules/windows/win_command.py +++ b/lib/ansible/modules/windows/win_command.py @@ -81,37 +81,37 @@ RETURN = r''' msg: description: changed returned: always - type: boolean + type: bool sample: True start: description: The command execution start time returned: always - type: string + type: str sample: '2016-02-25 09:18:26.429568' end: description: The command execution end time returned: always - type: string + type: str sample: '2016-02-25 09:18:26.755339' delta: description: The command execution delta time returned: always - type: string + type: str sample: '0:00:00.325771' stdout: description: The command standard output returned: always - type: string + type: str sample: 'Clustering node rabbit@slave1 with rabbit@master ...' stderr: description: The command standard error returned: always - type: string + type: str sample: 'ls: cannot access foo: No such file or directory' cmd: description: The command executed by the task returned: always - type: string + type: str sample: 'rabbitmqctl join_cluster rabbit@master' rc: description: The command return code (0 means success) diff --git a/lib/ansible/modules/windows/win_copy.py b/lib/ansible/modules/windows/win_copy.py index ce4224a5de..cf01af7d4d 100644 --- a/lib/ansible/modules/windows/win_copy.py +++ b/lib/ansible/modules/windows/win_copy.py @@ -143,17 +143,17 @@ RETURN = r''' dest: description: destination file/path returned: changed - type: string + type: str sample: C:\Temp\ src: description: source file used for the copy on the target machine returned: changed - type: string + type: str sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source checksum: description: sha1 checksum of the file after running copy returned: success, src is a file - type: string + type: str sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827 size: description: size of the target, after execution @@ -163,11 +163,11 @@ size: operation: description: whether a single file copy took place or a folder copy returned: success - type: string + type: str sample: file_copy original_basename: description: basename of the copied file returned: changed, src is a file - type: string + type: str sample: foo.txt ''' diff --git a/lib/ansible/modules/windows/win_defrag.py b/lib/ansible/modules/windows/win_defrag.py index f3ba58aa59..7bfd20bc59 100644 --- a/lib/ansible/modules/windows/win_defrag.py +++ b/lib/ansible/modules/windows/win_defrag.py @@ -68,7 +68,7 @@ RETURN = r''' cmd: description: The complete command line used by the module returned: always - type: string + type: str sample: defrag.exe /C /V rc: description: The return code for the command @@ -78,17 +78,17 @@ rc: stdout: description: The standard output from the command returned: always - type: string + type: str sample: Success. stderr: description: The error output from the command returned: always - type: string + type: str sample: msg: description: Possible error message on failure returned: failed - type: string + type: str sample: Command 'defrag.exe' not found in $env:PATH. changed: description: Whether or not any changes were made. diff --git a/lib/ansible/modules/windows/win_disk_facts.py b/lib/ansible/modules/windows/win_disk_facts.py index e6a9f836a0..16d912fdc9 100644 --- a/lib/ansible/modules/windows/win_disk_facts.py +++ b/lib/ansible/modules/windows/win_disk_facts.py @@ -77,17 +77,17 @@ ansible_facts: bus_type: description: Bus type of the particular disk. returned: always - type: string + type: str sample: "SCSI" friendly_name: description: Friendly name of the particular disk. returned: always - type: string + type: str sample: "Red Hat VirtIO SCSI Disk Device" partition_style: description: Partition style of the particular disk. returned: always - type: string + type: str sample: "MBR" partition_count: description: Number of partitions on the particular disk. @@ -97,7 +97,7 @@ ansible_facts: operational_status: description: Operational status of the particular disk. returned: always - type: string + type: str sample: "Online" sector_size: description: Sector size in bytes of the particular disk. @@ -127,42 +127,42 @@ ansible_facts: manufacturer: description: Manufacturer of the particular disk. returned: always - type: string + type: str sample: "Red Hat" model: description: Model specification of the particular disk. returned: always - type: string + type: str sample: "VirtIO" firmware_version: description: Firmware version of the particular disk. returned: always - type: string + type: str sample: "0001" location: description: Location of the particular disk on the target. returned: always - type: string + type: str sample: "PCIROOT(0)#PCI(0400)#SCSI(P00T00L00)" serial_number: description: Serial number of the particular disk on the target. returned: always - type: string + type: str sample: "b62beac80c3645e5877f" unique_id: description: Unique ID of the particular disk on the target. returned: always - type: string + type: str sample: "3141463431303031" guid: description: GUID of the particular disk on the target. returned: if existent - type: string + type: str sample: "{efa5f928-57b9-47fc-ae3e-902e85fbe77f}" path: description: Path of the particular disk on the target. returned: always - type: string + type: str sample: "\\\\?\\scsi#disk&ven_red_hat&prod_virtio#4&23208fd0&1&000000#{<id>}" partitions: description: Detailed information about one particular partition on the specified disk. @@ -183,12 +183,12 @@ ansible_facts: type: description: Type of the particular partition. returned: always - type: string + type: str sample: "IFS" gpt_type: description: gpt type of the particular partition. returned: if partition_style property of the particular disk has value "GPT" - type: string + type: str sample: "{e3c9e316-0b5c-4db8-817d-f92df00215ae}" no_default_driveletter: description: Information whether the particular partition has a default drive letter or not. @@ -208,7 +208,7 @@ ansible_facts: drive_letter: description: Drive letter of the particular partition. returned: if existent - type: string + type: str sample: "C" transition_state: description: Transition state of the particular partition. @@ -233,12 +233,12 @@ ansible_facts: guid: description: GUID of the particular partition. returned: if existent - type: string + type: str sample: "{302e475c-6e64-4674-a8e2-2f1c7018bf97}" access_paths: description: Access paths of the particular partition. returned: if existent - type: string + type: str sample: "\\\\?\\Volume{85bdc4a8-f8eb-11e6-80fa-806e6f6e6963}\\" volumes: description: Detailed information about one particular volume on the specified partition. @@ -260,22 +260,22 @@ ansible_facts: type: description: File system type of the particular volume. returned: always - type: string + type: str sample: "NTFS" label: description: File system label of the particular volume. returned: always - type: string + type: str sample: "System Reserved" health_status: description: Health status of the particular volume. returned: always - type: string + type: str sample: "Healthy" drive_type: description: Drive type of the particular volume. returned: always - type: string + type: str sample: "Fixed" allocation_unit_size: description: Allocation unit size in bytes of the particular volume. @@ -285,12 +285,12 @@ ansible_facts: object_id: description: Object ID of the particular volume. returned: always - type: string + type: str sample: "\\\\?\\Volume{85bdc4a9-f8eb-11e6-80fa-806e6f6e6963}\\" path: description: Path of the particular volume. returned: always - type: string + type: str sample: "\\\\?\\Volume{85bdc4a9-f8eb-11e6-80fa-806e6f6e6963}\\" physical_disk: description: Detailed information about physical disk properties of the particular disk. @@ -300,7 +300,7 @@ ansible_facts: media_type: description: Media type of the particular physical disk. returned: always - type: string + type: str sample: "UnSpecified" size: description: @@ -317,32 +317,32 @@ ansible_facts: device_id: description: Device ID of the particular physical disk. returned: always - type: string + type: str sample: "0" friendly_name: description: Friendly name of the particular physical disk. returned: always - type: string + type: str sample: "PhysicalDisk0" operational_status: description: Operational status of the particular physical disk. returned: always - type: string + type: str sample: "OK" health_status: description: Health status of the particular physical disk. returned: always - type: string + type: str sample: "Healthy" bus_type: description: Bus type of the particular physical disk. returned: always - type: string + type: str sample: "SCSI" usage_type: description: Usage type of the particular physical disk. returned: always - type: string + type: str sample: "Auto-Select" supported_usages: description: Supported usage types of the particular physical disk. @@ -357,7 +357,7 @@ ansible_facts: value: description: List of supported usage types. returned: always - type: string + type: str sample: "Auto-Select, Hot Spare" spindle_speed: description: Spindle speed in rpm of the particular physical disk. @@ -367,17 +367,17 @@ ansible_facts: physical_location: description: Physical location of the particular physical disk. returned: always - type: string + type: str sample: "Integrated : Adapter 3 : Port 0 : Target 0 : LUN 0" manufacturer: description: Manufacturer of the particular physical disk. returned: always - type: string + type: str sample: "SUSE" model: description: Model of the particular physical disk. returned: always - type: string + type: str sample: "Xen Block" can_pool: description: Information whether the particular physical disk can be added to a storage pool. @@ -387,7 +387,7 @@ ansible_facts: cannot_pool_reason: description: Information why the particular physical disk can not be added to a storage pool. returned: if can_pool property has value false - type: string + type: str sample: "Insufficient Capacity" indication_enabled: description: Information whether indication is enabled for the particular physical disk. @@ -402,17 +402,17 @@ ansible_facts: serial_number: description: Serial number of the particular physical disk. returned: always - type: string + type: str sample: "b62beac80c3645e5877f" object_id: description: Object ID of the particular physical disk. returned: always - type: string + type: str sample: '{1}\\\\HOST\\root/Microsoft/Windows/Storage/Providers_v2\\SPACES_PhysicalDisk.ObjectId=\"{<object_id>}:PD:{<pd>}\"' unique_id: description: Unique ID of the particular physical disk. returned: always - type: string + type: str sample: "3141463431303031" virtual_disk: description: Detailed information about virtual disk properties of the particular disk. @@ -440,27 +440,27 @@ ansible_facts: name: description: Name of the particular virtual disk. returned: always - type: string + type: str sample: "vDisk1" friendly_name: description: Friendly name of the particular virtual disk. returned: always - type: string + type: str sample: "Prod2 Virtual Disk" operational_status: description: Operational status of the particular virtual disk. returned: always - type: string + type: str sample: "OK" health_status: description: Health status of the particular virtual disk. returned: always - type: string + type: str sample: "Healthy" provisioning_type: description: Provisioning type of the particular virtual disk. returned: always - type: string + type: str sample: "Thin" allocation_unit_size: description: Allocation unit size in bytes of the particular virtual disk. @@ -470,7 +470,7 @@ ansible_facts: media_type: description: Media type of the particular virtual disk. returned: always - type: string + type: str sample: "Unspecified" parity_layout: description: Parity layout of the particular virtual disk. @@ -480,12 +480,12 @@ ansible_facts: access: description: Access of the particular virtual disk. returned: always - type: string + type: str sample: "Read/Write" detached_reason: description: Detached reason of the particular virtual disk. returned: always - type: string + type: str sample: "None" write_cache_size: description: Write cache size in byte of the particular virtual disk. @@ -495,7 +495,7 @@ ansible_facts: fault_domain_awareness: description: Fault domain awareness of the particular virtual disk. returned: always - type: string + type: str sample: "PhysicalDisk" inter_leave: description: @@ -576,16 +576,16 @@ ansible_facts: object_id: description: Object ID of the particular virtual disk. returned: always - type: string + type: str sample: '{1}\\\\HOST\\root/Microsoft/Windows/Storage/Providers_v2\\SPACES_VirtualDisk.ObjectId=\"{<object_id>}:VD:{<vd>}\"' unique_id: description: Unique ID of the particular virtual disk. returned: always - type: string + type: str sample: "260542E4C6B01D47A8FA7630FD90FFDE" unique_id_format: description: Unique ID format of the particular virtual disk. returned: always - type: string + type: str sample: "Vendor Specific" ''' diff --git a/lib/ansible/modules/windows/win_disk_image.py b/lib/ansible/modules/windows/win_disk_image.py index 2e942895ca..2153013f4b 100644 --- a/lib/ansible/modules/windows/win_disk_image.py +++ b/lib/ansible/modules/windows/win_disk_image.py @@ -34,7 +34,7 @@ RETURN = r''' mount_path: description: filesystem path where the target image is mounted, this has been deprecated in favour of C(mount_paths) returned: when C(state) is C(present) - type: string + type: str sample: F:\ mount_paths: description: a list of filesystem paths mounted from the target image diff --git a/lib/ansible/modules/windows/win_domain.py b/lib/ansible/modules/windows/win_domain.py index f64a2b92a4..8aa50aecb2 100644 --- a/lib/ansible/modules/windows/win_domain.py +++ b/lib/ansible/modules/windows/win_domain.py @@ -85,7 +85,7 @@ RETURN = r''' reboot_required: description: True if changes were made that require a reboot. returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/windows/win_domain_controller.py b/lib/ansible/modules/windows/win_domain_controller.py index d05dadd9a6..f3f0b7dd29 100644 --- a/lib/ansible/modules/windows/win_domain_controller.py +++ b/lib/ansible/modules/windows/win_domain_controller.py @@ -81,7 +81,7 @@ RETURN = ''' reboot_required: description: True if changes were made that require a reboot. returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/windows/win_domain_group.py b/lib/ansible/modules/windows/win_domain_group.py index ded226edd8..a55a956a99 100644 --- a/lib/ansible/modules/windows/win_domain_group.py +++ b/lib/ansible/modules/windows/win_domain_group.py @@ -171,48 +171,48 @@ attributes: canonical_name: description: The canonical name of the group. returned: group exists - type: string + type: str sample: ansible.local/groups/Cow category: description: The Group type value of the group, i.e. Security or Distribution. returned: group exists - type: string + type: str sample: Security description: description: The Description of the group. returned: group exists - type: string + type: str sample: Group Description display_name: description: The Display name of the group. returned: group exists - type: string + type: str sample: Users who connect through RDP distinguished_name: description: The full Distinguished Name of the group. returned: group exists - type: string + type: str sample: CN=Cow,OU=groups,DC=ansible,DC=local group_scope: description: The Group scope value of the group. returned: group exists - type: string + type: str sample: Universal guid: description: The guid of the group. returned: group exists - type: string + type: str sample: 512a9adb-3fc0-4a26-9df0-e6ea1740cf45 managed_by: description: The full Distinguished Name of the AD object that is set on the managedBy attribute. returned: group exists - type: string + type: str sample: CN=Domain Admins,CN=Users,DC=ansible,DC=local name: description: The name of the group. returned: group exists - type: string + type: str sample: Cow protected_from_accidental_deletion: description: Whether the group is protected from accidental deletion. @@ -222,6 +222,6 @@ protected_from_accidental_deletion: sid: description: The Security ID of the group. returned: group exists - type: string + type: str sample: S-1-5-21-2171456218-3732823212-122182344-1189 ''' diff --git a/lib/ansible/modules/windows/win_domain_membership.py b/lib/ansible/modules/windows/win_domain_membership.py index a8daa50404..6808013b8b 100644 --- a/lib/ansible/modules/windows/win_domain_membership.py +++ b/lib/ansible/modules/windows/win_domain_membership.py @@ -58,7 +58,7 @@ RETURN = ''' reboot_required: description: True if changes were made that require a reboot. returned: always - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/windows/win_domain_user.py b/lib/ansible/modules/windows/win_domain_user.py index d5f6d320aa..33980f872a 100644 --- a/lib/ansible/modules/windows/win_domain_user.py +++ b/lib/ansible/modules/windows/win_domain_user.py @@ -229,52 +229,52 @@ RETURN = r''' account_locked: description: true if the account is locked returned: always - type: boolean + type: bool sample: false changed: description: true if the account changed during execution returned: always - type: boolean + type: bool sample: false city: description: The user city returned: always - type: string + type: str sample: Indianapolis company: description: The user company returned: always - type: string + type: str sample: RedHat country: description: The user country returned: always - type: string + type: str sample: US description: description: A description of the account returned: always - type: string + type: str sample: Server Administrator distinguished_name: description: DN of the user account returned: always - type: string + type: str sample: CN=nick,OU=test,DC=domain,DC=local email: description: The user email address returned: always - type: string + type: str sample: nick@domain.local enabled: description: true if the account is enabled and false if disabled returned: always - type: string + type: str sample: true firstname: description: The user first name returned: always - type: string + type: str sample: Nick groups: description: AD Groups to which the account belongs @@ -284,61 +284,61 @@ groups: msg: description: Summary message of whether the user is present or absent returned: always - type: string + type: str sample: User nick is present name: description: The username on the account returned: always - type: string + type: str sample: nick password_expired: description: true if the account password has expired returned: always - type: boolean + type: bool sample: false password_updated: description: true if the password changed during this execution returned: always - type: boolean + type: bool sample: true postal_code: description: The user postal code returned: always - type: string + type: str sample: 46033 sid: description: The SID of the account returned: always - type: string + type: str sample: S-1-5-21-2752426336-228313920-2202711348-1175 state: description: The state of the user account returned: always - type: string + type: str sample: present state_province: description: The user state or province returned: always - type: string + type: str sample: IN street: description: The user street address returned: always - type: string + type: str sample: 123 4th St. surname: description: The user last name returned: always - type: string + type: str sample: Doe upn: description: The User Principal Name of the account returned: always - type: string + type: str sample: nick@domain.local user_cannot_change_password: description: true if the user is not allowed to change password returned: always - type: string + type: str sample: false ''' diff --git a/lib/ansible/modules/windows/win_dsc.py b/lib/ansible/modules/windows/win_dsc.py index ba72d98397..e4efe56470 100644 --- a/lib/ansible/modules/windows/win_dsc.py +++ b/lib/ansible/modules/windows/win_dsc.py @@ -135,17 +135,17 @@ RETURN = r''' module_version: description: The version of the dsc resource/module used. returned: success - type: string + type: str sample: "1.0.1" reboot_required: description: Flag returned from the DSC engine indicating whether or not the machine requires a reboot for the invoked changes to take effect. returned: always - type: boolean + type: bool sample: True message: description: any error message from invoking the DSC resource returned: error - type: string + type: str sample: Multiple DSC modules found with resource name xyz ''' diff --git a/lib/ansible/modules/windows/win_environment.py b/lib/ansible/modules/windows/win_environment.py index e6dd507938..f100feeb12 100644 --- a/lib/ansible/modules/windows/win_environment.py +++ b/lib/ansible/modules/windows/win_environment.py @@ -75,11 +75,11 @@ RETURN = r''' before_value: description: the value of the environment key before a change, this is null if it didn't exist returned: always - type: string + type: str sample: C:\Windows\System32 value: description: the value the environment key has been set to, this is null if removed returned: always - type: string + type: str sample: C:\Program Files\jdk1.8 ''' diff --git a/lib/ansible/modules/windows/win_eventlog.py b/lib/ansible/modules/windows/win_eventlog.py index 829bc39727..940c686147 100644 --- a/lib/ansible/modules/windows/win_eventlog.py +++ b/lib/ansible/modules/windows/win_eventlog.py @@ -124,12 +124,12 @@ RETURN = r''' name: description: The name of the event log. returned: always - type: string + type: str sample: MyNewLog exists: description: Whether the event log exists or not. returned: success - type: boolean + type: bool sample: true entries: description: The count of entries present in the event log. @@ -144,7 +144,7 @@ maximum_size_kb: overflow_action: description: The action the log takes once it reaches its maximum size. returned: success - type: string + type: str sample: OverwriteOlder retention_days: description: The minimum number of days entries are retained in the log. diff --git a/lib/ansible/modules/windows/win_feature.py b/lib/ansible/modules/windows/win_feature.py index a3afec1882..52ee1f6f58 100644 --- a/lib/ansible/modules/windows/win_feature.py +++ b/lib/ansible/modules/windows/win_feature.py @@ -94,7 +94,7 @@ RETURN = r''' exitcode: description: The stringified exit code from the feature installation/removal command returned: always - type: string + type: str sample: Success feature_result: description: List of features that were installed or removed @@ -105,7 +105,7 @@ feature_result: display_name: description: Feature display name returned: always - type: string + type: str sample: "Telnet Client" id: description: A list of KB article IDs that apply to the update @@ -120,27 +120,27 @@ feature_result: reboot_required: description: True when the target server requires a reboot as a result of installing or removing this feature returned: always - type: boolean + type: bool sample: True restart_needed: description: DEPRECATED in Ansible 2.4 (refer to C(reboot_required) instead). True when the target server requires a reboot as a result of installing or removing this feature returned: always - type: boolean + type: bool sample: True skip_reason: description: The reason a feature installation or removal was skipped returned: always - type: string + type: str sample: NotSkipped success: description: If the feature installation or removal was successful returned: always - type: boolean + type: bool sample: True reboot_required: description: True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot) returned: success - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/windows/win_file_version.py b/lib/ansible/modules/windows/win_file_version.py index 05470a80ae..effa715293 100644 --- a/lib/ansible/modules/windows/win_file_version.py +++ b/lib/ansible/modules/windows/win_file_version.py @@ -44,35 +44,35 @@ RETURN = r''' win_file_version.path: description: file path returned: always - type: string + type: str win_file_version.file_version: description: file version number. returned: no error - type: string + type: str win_file_version.product_version: description: the version of the product this file is distributed with. returned: no error - type: string + type: str win_file_version.file_major_part: description: the major part of the version number. returned: no error - type: string + type: str win_file_version.file_minor_part: description: the minor part of the version number of the file. returned: no error - type: string + type: str win_file_version.file_build_part: description: build number of the file. returned: no error - type: string + type: str win_file_version.file_private_part: description: file private part number. returned: no error - type: string + type: str ''' diff --git a/lib/ansible/modules/windows/win_find.py b/lib/ansible/modules/windows/win_find.py index a0bfbe31c6..385ee6f661 100644 --- a/lib/ansible/modules/windows/win_find.py +++ b/lib/ansible/modules/windows/win_find.py @@ -215,12 +215,12 @@ files: attributes: description: attributes of the file at path in raw form returned: success, path exists - type: string + type: str sample: "Archive, Hidden" checksum: description: The checksum of a file based on checksum_algorithm specified returned: success, path exists, path is a file, get_checksum == True - type: string + type: str sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98 creationtime: description: the create time of the file represented in seconds since epoch @@ -230,37 +230,37 @@ files: extension: description: the extension of the file at path returned: success, path exists, path is a file - type: string + type: str sample: ".ps1" isarchive: description: if the path is ready for archiving or not returned: success, path exists - type: boolean + type: bool sample: True isdir: description: if the path is a directory or not returned: success, path exists - type: boolean + type: bool sample: True ishidden: description: if the path is hidden or not returned: success, path exists - type: boolean + type: bool sample: True islnk: description: if the path is a symbolic link or junction or not returned: success, path exists - type: boolean + type: bool sample: True isreadonly: description: if the path is read only or not returned: success, path exists - type: boolean + type: bool sample: True isshared: description: if the path is shared or not returned: success, path exists - type: boolean + type: bool sample: True lastaccesstime: description: the last access time of the file represented in seconds since epoch @@ -275,22 +275,22 @@ files: lnk_source: description: the target of the symbolic link, will return null if not a link or the link is broken return: success, path exists, path is a symbolic link - type: string + type: str sample: C:\temp owner: description: the owner of the file returned: success, path exists - type: string + type: str sample: BUILTIN\Administrators path: description: the full absolute path to the file returned: success, path exists - type: string + type: str sample: BUILTIN\Administrators sharename: description: the name of share if folder is shared returned: success, path exists, path is a directory and isshared == True - type: string + type: str sample: file-share size: description: the size in bytes of a file or folder diff --git a/lib/ansible/modules/windows/win_firewall.py b/lib/ansible/modules/windows/win_firewall.py index 0d7cc545f8..a851366d75 100644 --- a/lib/ansible/modules/windows/win_firewall.py +++ b/lib/ansible/modules/windows/win_firewall.py @@ -69,7 +69,7 @@ enabled: profiles: description: chosen profile returned: always - type: string + type: str sample: Domain state: description: desired state of the given firewall profile(s) diff --git a/lib/ansible/modules/windows/win_get_url.py b/lib/ansible/modules/windows/win_get_url.py index 749d754e1e..ebe558ce80 100644 --- a/lib/ansible/modules/windows/win_get_url.py +++ b/lib/ansible/modules/windows/win_get_url.py @@ -146,7 +146,7 @@ RETURN = r''' dest: description: destination file/path returned: always - type: string + type: str sample: C:\Users\RandomUser\earthrise.jpg elapsed: description: The elapsed seconds between the start of poll and the end of the module. @@ -156,12 +156,12 @@ elapsed: url: description: requested url returned: always - type: string + type: str sample: http://www.example.com/earthrise.jpg msg: description: Error message, or HTTP status message from web-server returned: always - type: string + type: str sample: OK status_code: description: HTTP status code diff --git a/lib/ansible/modules/windows/win_group_membership.py b/lib/ansible/modules/windows/win_group_membership.py index 93cb84b8cd..add62833c0 100644 --- a/lib/ansible/modules/windows/win_group_membership.py +++ b/lib/ansible/modules/windows/win_group_membership.py @@ -66,7 +66,7 @@ RETURN = r''' name: description: The name of the target local group. returned: always - type: string + type: str sample: Administrators added: description: A list of members added when C(state) is C(present); this is diff --git a/lib/ansible/modules/windows/win_iis_webapplication.py b/lib/ansible/modules/windows/win_iis_webapplication.py index 4e177992cc..5d289a1176 100644 --- a/lib/ansible/modules/windows/win_iis_webapplication.py +++ b/lib/ansible/modules/windows/win_iis_webapplication.py @@ -58,11 +58,11 @@ RETURN = r''' application_pool: description: The used/implemented application_pool value returned: success - type: string + type: str sample: DefaultAppPool physical_path: description: The used/implemented physical_path value returned: success - type: string + type: str sample: C:\apps\acme\api ''' diff --git a/lib/ansible/modules/windows/win_iis_webapppool.py b/lib/ansible/modules/windows/win_iis_webapppool.py index 0ea84fcb8d..557eb7cdd0 100644 --- a/lib/ansible/modules/windows/win_iis_webapppool.py +++ b/lib/ansible/modules/windows/win_iis_webapppool.py @@ -127,7 +127,7 @@ attributes: description: Application Pool attributes that were set and processed by this module invocation. returned: success - type: dictionary + type: dict sample: enable32BitAppOnWin64: "true" managedRuntimeVersion: "v4.0" @@ -143,7 +143,7 @@ info: attributes: description: Key value pairs showing the current Application Pool attributes. returned: success - type: dictionary + type: dict sample: autoStart: true managedRuntimeLoader: "webengine4.dll" @@ -161,7 +161,7 @@ info: cpu: description: Key value pairs showing the current Application Pool cpu attributes. returned: success - type: dictionary + type: dict sample: action: "NoAction" limit: 0 @@ -171,7 +171,7 @@ info: failure: description: Key value pairs showing the current Application Pool failure attributes. returned: success - type: dictionary + type: dict sample: autoShutdownExe: "" orphanActionExe: "" @@ -181,12 +181,12 @@ info: name: description: Name of Application Pool that was processed by this module invocation. returned: success - type: string + type: str sample: "DefaultAppPool" processModel: description: Key value pairs showing the current Application Pool processModel attributes. returned: success - type: dictionary + type: dict sample: identityType: "ApplicationPoolIdentity" logonType: "LogonBatch" @@ -196,7 +196,7 @@ info: recycling: description: Key value pairs showing the current Application Pool recycling attributes. returned: success - type: dictionary + type: dict sample: disallowOverlappingRotation: false disallowRotationOnConfigChange: false @@ -204,6 +204,6 @@ info: state: description: Current runtime state of the pool as the module completed. returned: success - type: string + type: str sample: "Started" ''' diff --git a/lib/ansible/modules/windows/win_iis_webbinding.py b/lib/ansible/modules/windows/win_iis_webbinding.py index 5e5e85a1f1..7063eda891 100644 --- a/lib/ansible/modules/windows/win_iis_webbinding.py +++ b/lib/ansible/modules/windows/win_iis_webbinding.py @@ -114,7 +114,7 @@ website_state: - Can be helpful in case you accidentally cause a binding collision which can result in the targetted site being stopped returned: always - type: string + type: str sample: "Started" version_added: "2.5" operation_type: @@ -122,14 +122,14 @@ operation_type: - The type of operation performed - Can be removed, updated, matched, or added returned: on success - type: string + type: str sample: "removed" version_added: "2.5" binding_info: description: - Information on the binding being manipulated returned: on success - type: dictionary + type: dict sample: |- "binding_info": { "bindingInformation": "127.0.0.1:443:", diff --git a/lib/ansible/modules/windows/win_msg.py b/lib/ansible/modules/windows/win_msg.py index 0aea19a3d0..07883026e1 100644 --- a/lib/ansible/modules/windows/win_msg.py +++ b/lib/ansible/modules/windows/win_msg.py @@ -64,12 +64,12 @@ RETURN = r''' msg: description: Test of the message that was sent. returned: changed - type: string + type: str sample: Automated upgrade about to start. Please save your work and log off before 22 July 2016 18:00:00 display_seconds: description: Value of display_seconds module parameter. returned: success - type: string + type: str sample: 10 rc: description: The return code of the API call @@ -79,16 +79,16 @@ rc: runtime_seconds: description: How long the module took to run on the remote windows host. returned: success - type: string + type: str sample: 22 July 2016 17:45:51 sent_localtime: description: local time from windows host when the message was sent. returned: success - type: string + type: str sample: 22 July 2016 17:45:51 wait: description: Value of wait module parameter. returned: success - type: boolean + type: bool sample: false ''' diff --git a/lib/ansible/modules/windows/win_pagefile.py b/lib/ansible/modules/windows/win_pagefile.py index ed59ed775a..6cef5652ba 100644 --- a/lib/ansible/modules/windows/win_pagefile.py +++ b/lib/ansible/modules/windows/win_pagefile.py @@ -124,7 +124,7 @@ RETURN = r''' automatic_managed_pagefiles: description: Whether the pagefiles is automatically managed. returned: When state is query. - type: boolean + type: bool sample: true pagefiles: description: Contains caption, description, initial_size, maximum_size and name for each pagefile in the system. diff --git a/lib/ansible/modules/windows/win_pester.py b/lib/ansible/modules/windows/win_pester.py index 546b563224..25918dcec5 100644 --- a/lib/ansible/modules/windows/win_pester.py +++ b/lib/ansible/modules/windows/win_pester.py @@ -36,7 +36,7 @@ RETURN = r''' pester_version: description: Version of the pester module found on the remote host. returned: always - type: string + type: str sample: 4.3.1 output: description: Results of the Pester tests. diff --git a/lib/ansible/modules/windows/win_ping.py b/lib/ansible/modules/windows/win_ping.py index 0cce9f042c..7ca5cba68d 100644 --- a/lib/ansible/modules/windows/win_ping.py +++ b/lib/ansible/modules/windows/win_ping.py @@ -52,6 +52,6 @@ RETURN = ''' ping: description: value provided with the data parameter returned: success - type: string + type: str sample: pong ''' diff --git a/lib/ansible/modules/windows/win_power_plan.py b/lib/ansible/modules/windows/win_power_plan.py index 5bfd151552..3ab5bcb3e2 100644 --- a/lib/ansible/modules/windows/win_power_plan.py +++ b/lib/ansible/modules/windows/win_power_plan.py @@ -39,17 +39,17 @@ RETURN = r''' power_plan_name: description: Value of the intended power plan returned: always - type: string + type: str sample: balanced power_plan_enabled: description: State of the intended power plan returned: success - type: boolean + type: bool sample: True all_available_plans: description: The name and enabled state of all power plans returned: always - type: dictionary + type: dict sample: | { "High performance": false, diff --git a/lib/ansible/modules/windows/win_product_facts.py b/lib/ansible/modules/windows/win_product_facts.py index 009bb757bb..8f9a6a60a1 100644 --- a/lib/ansible/modules/windows/win_product_facts.py +++ b/lib/ansible/modules/windows/win_product_facts.py @@ -29,7 +29,7 @@ RETURN = ''' ansible_facts: description: returned facts by this module returned: always - type: dictionary + type: dict sample: ansible_os_product_id: 00326-10000-00000-AA698 ansible_os_product_key: T49TD-6VFBW-VV7HY-B2PXY-MY47H diff --git a/lib/ansible/modules/windows/win_psexec.py b/lib/ansible/modules/windows/win_psexec.py index 1081450f7b..d46a2223ac 100644 --- a/lib/ansible/modules/windows/win_psexec.py +++ b/lib/ansible/modules/windows/win_psexec.py @@ -150,7 +150,7 @@ RETURN = r''' cmd: description: The complete command line used by the module, including PsExec call and additional options. returned: always - type: string + type: str sample: psexec.exe -nobanner \\remote_server -u "DOMAIN\Administrator" -p "some_password" -accepteula E:\setup.exe rc: description: The return code for the command @@ -160,11 +160,11 @@ rc: stdout: description: The standard output from the command returned: always - type: string + type: str sample: Success. stderr: description: The error output from the command returned: always - type: string + type: str sample: Error 15 running E:\setup.exe ''' diff --git a/lib/ansible/modules/windows/win_psmodule.py b/lib/ansible/modules/windows/win_psmodule.py index 605482fddb..fa48733899 100644 --- a/lib/ansible/modules/windows/win_psmodule.py +++ b/lib/ansible/modules/windows/win_psmodule.py @@ -86,15 +86,15 @@ output: description: a message describing the task result. returned: always sample: "Module PowerShellCookbook installed" - type: string + type: str nuget_changed: description: true when Nuget package provider is installed returned: always - type: boolean + type: bool sample: True repository_changed: description: true when a custom repository is installed or removed returned: always - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/windows/win_reboot.py b/lib/ansible/modules/windows/win_reboot.py index e088773ad8..f98b90b6c6 100644 --- a/lib/ansible/modules/windows/win_reboot.py +++ b/lib/ansible/modules/windows/win_reboot.py @@ -111,7 +111,7 @@ RETURN = r''' rebooted: description: true if the machine was rebooted returned: always - type: boolean + type: bool sample: true elapsed: description: The number of seconds that elapsed waiting for the system to be rebooted. diff --git a/lib/ansible/modules/windows/win_reg_stat.py b/lib/ansible/modules/windows/win_reg_stat.py index fa4143907b..631f99b528 100644 --- a/lib/ansible/modules/windows/win_reg_stat.py +++ b/lib/ansible/modules/windows/win_reg_stat.py @@ -53,12 +53,12 @@ RETURN = r''' changed: description: Whether anything was changed. returned: always - type: boolean + type: bool sample: True exists: description: States whether the registry key/property exists. returned: success and path/property exists - type: boolean + type: bool sample: True properties: description: A dictionary containing all the properties and their values in the registry key. @@ -89,16 +89,16 @@ raw_value: description: Returns the raw value of the registry property, REG_EXPAND_SZ has no string expansion, REG_BINARY or REG_NONE is in hex 0x format. REG_NONE, this value is a hex string in the 0x format. returned: success, path/property exists and property specified - type: string + type: str sample: '%ProgramDir%\\Common Files' type: description: The property type. returned: success, path/property exists and property specified - type: string + type: str sample: "REG_EXPAND_SZ" value: description: The value of the property. returned: success, path/property exists and property specified - type: string + type: str sample: 'C:\\Program Files\\Common Files' ''' diff --git a/lib/ansible/modules/windows/win_regedit.py b/lib/ansible/modules/windows/win_regedit.py index b6e47cf697..03a3f34e9e 100644 --- a/lib/ansible/modules/windows/win_regedit.py +++ b/lib/ansible/modules/windows/win_regedit.py @@ -186,7 +186,7 @@ EXAMPLES = r''' path: HKLM:\ANSIBLE\Control Panel\Mouse name: MouseTrails data: 10 - type: string + type: str state: present hive: C:\Users\Default\NTUSER.dat ''' @@ -195,11 +195,11 @@ RETURN = r''' data_changed: description: whether this invocation changed the data in the registry value returned: success - type: boolean + type: bool sample: False data_type_changed: description: whether this invocation changed the datatype of the registry value returned: success - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/windows/win_region.py b/lib/ansible/modules/windows/win_region.py index 25f19b1568..fc10200ef7 100644 --- a/lib/ansible/modules/windows/win_region.py +++ b/lib/ansible/modules/windows/win_region.py @@ -90,6 +90,6 @@ RETURN = r''' restart_required: description: Whether a reboot is required for the change to take effect returned: success - type: boolean + type: bool sample: True ''' diff --git a/lib/ansible/modules/windows/win_regmerge.py b/lib/ansible/modules/windows/win_regmerge.py index 5c328583a4..d2c3546c5c 100644 --- a/lib/ansible/modules/windows/win_regmerge.py +++ b/lib/ansible/modules/windows/win_regmerge.py @@ -66,7 +66,7 @@ RETURN = r''' compare_to_key_found: description: whether the parent registry key has been found for comparison returned: when comparison key not found in registry - type: boolean + type: bool sample: false difference_count: description: number of differences between the registry and the file @@ -76,6 +76,6 @@ difference_count: compared: description: whether a comparison has taken place between the registry and the file returned: when a comparison key has been supplied and comparison has been attempted - type: boolean + type: bool sample: true ''' diff --git a/lib/ansible/modules/windows/win_robocopy.py b/lib/ansible/modules/windows/win_robocopy.py index 316e33ce30..941340216a 100644 --- a/lib/ansible/modules/windows/win_robocopy.py +++ b/lib/ansible/modules/windows/win_robocopy.py @@ -99,17 +99,17 @@ RETURN = r''' cmd: description: The used command line returned: always - type: string + type: str sample: robocopy C:\DirectoryOne C:\DirectoryTwo /e /purge src: description: The Source file/directory of the sync. returned: always - type: string + type: str sample: C:\Some\Path dest: description: The Destination file/directory of the sync. returned: always - type: string + type: str sample: C:\Some\Path recurse: description: Whether or not the recurse flag was toggled. @@ -124,7 +124,7 @@ purge: flags: description: Any flags passed in by the user. returned: always - type: string + type: str sample: /e /purge rc: description: The return code returned by robocopy. @@ -134,11 +134,11 @@ rc: output: description: The output of running the robocopy command. returned: success - type: string + type: str sample: "------------------------------------\\n ROBOCOPY :: Robust File Copy for Windows \\n------------------------------------\\n " msg: description: Output intrepreted into a concise message. returned: always - type: string + type: str sample: No files copied! ''' diff --git a/lib/ansible/modules/windows/win_route.py b/lib/ansible/modules/windows/win_route.py index 66179ffae4..4912c22e5b 100644 --- a/lib/ansible/modules/windows/win_route.py +++ b/lib/ansible/modules/windows/win_route.py @@ -62,6 +62,6 @@ RETURN = r''' output: description: A message describing the task result. returned: always - type: string + type: str sample: "Route added" ''' diff --git a/lib/ansible/modules/windows/win_say.py b/lib/ansible/modules/windows/win_say.py index c8fc9bb7f3..74ada0fdf6 100644 --- a/lib/ansible/modules/windows/win_say.py +++ b/lib/ansible/modules/windows/win_say.py @@ -100,16 +100,16 @@ RETURN = r''' message_text: description: the text that the module attempted to speak returned: success - type: string + type: str sample: "Warning, deployment commencing in 5 minutes." voice: description: the voice used to speak the text. returned: success - type: string + type: str sample: Microsoft Hazel Desktop voice_info: description: the voice used to speak the text. returned: when requested voice could not be loaded - type: string + type: str sample: Could not load voice TestVoice, using system default voice ''' diff --git a/lib/ansible/modules/windows/win_scheduled_task_stat.py b/lib/ansible/modules/windows/win_scheduled_task_stat.py index 342d8bff65..269927be07 100644 --- a/lib/ansible/modules/windows/win_scheduled_task_stat.py +++ b/lib/ansible/modules/windows/win_scheduled_task_stat.py @@ -69,7 +69,7 @@ actions: folder_exists: description: Whether the folder set at path exists. returned: always - type: boolean + type: bool sample: True folder_task_count: description: The number of tasks that exist in the folder. @@ -219,7 +219,7 @@ settings: idle_settings: description: The idle settings of the task. returned: '' - type: dictionary + type: dict sample: { "idle_duration": "PT10M", "restart_on_idle": false, @@ -240,7 +240,7 @@ settings: network_settings: description: The network settings of the task. returned: '' - type: dictionary + type: dict sample: { "id": null, "name": null @@ -335,7 +335,7 @@ state: task_exists: description: Whether the task at the folder exists. returned: name is specified - type: boolean + type: bool sample: True triggers: description: A list of triggers. diff --git a/lib/ansible/modules/windows/win_security_policy.py b/lib/ansible/modules/windows/win_security_policy.py index 0019a0846a..a57e1b2690 100644 --- a/lib/ansible/modules/windows/win_security_policy.py +++ b/lib/ansible/modules/windows/win_security_policy.py @@ -91,33 +91,33 @@ stdout: description: The output of the STDOUT buffer after a failure when running SecEdit.exe. returned: failure with secedit calls - type: string + type: str sample: check log for error details stderr: description: The output of the STDERR buffer after a failure when running SecEdit.exe. returned: failure with secedit calls - type: string + type: str sample: failed to import security policy import_log: description: The log of the SecEdit.exe /configure job that configured the local policies. This is used for debugging purposes on failures. returned: secedit.exe /import run and change occurred - type: string + type: str sample: Completed 6 percent (0/15) \tProcess Privilege Rights area. key: description: The key in the section passed to the module to modify. returned: success - type: string + type: str sample: NewGuestName section: description: The section passed to the module to modify. returned: success - type: string + type: str sample: System Access value: description: The value passed to the module to modify to. returned: success - type: string + type: str sample: Guest Account ''' diff --git a/lib/ansible/modules/windows/win_service.py b/lib/ansible/modules/windows/win_service.py index 9cb32af614..c491da70ee 100644 --- a/lib/ansible/modules/windows/win_service.py +++ b/lib/ansible/modules/windows/win_service.py @@ -232,32 +232,32 @@ RETURN = r''' exists: description: Whether the service exists or not. returned: success - type: boolean + type: bool sample: true name: description: The service name or id of the service. returned: success and service exists - type: string + type: str sample: CoreMessagingRegistrar display_name: description: The display name of the installed service. returned: success and service exists - type: string + type: str sample: CoreMessaging state: description: The current running status of the service. returned: success and service exists - type: string + type: str sample: stopped start_mode: description: The startup type of the service. returned: success and service exists - type: string + type: str sample: manual path: description: The path to the service executable. returned: success and service exists - type: string + type: str sample: C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork can_pause_and_continue: description: Whether the service can be paused and unpaused. @@ -267,17 +267,17 @@ can_pause_and_continue: description: description: The description of the service. returned: success and service exists - type: string + type: str sample: Manages communication between system components. username: description: The username that runs the service. returned: success and service exists - type: string + type: str sample: LocalSystem desktop_interact: description: Whether the current user is allowed to interact with the desktop. returned: success and service exists - type: boolean + type: bool sample: False dependencies: description: A list of services that is depended by this service. diff --git a/lib/ansible/modules/windows/win_shell.py b/lib/ansible/modules/windows/win_shell.py index 1b3ece5613..bbb0a9da08 100644 --- a/lib/ansible/modules/windows/win_shell.py +++ b/lib/ansible/modules/windows/win_shell.py @@ -105,37 +105,37 @@ RETURN = r''' msg: description: changed returned: always - type: boolean + type: bool sample: True start: description: The command execution start time returned: always - type: string + type: str sample: '2016-02-25 09:18:26.429568' end: description: The command execution end time returned: always - type: string + type: str sample: '2016-02-25 09:18:26.755339' delta: description: The command execution delta time returned: always - type: string + type: str sample: '0:00:00.325771' stdout: description: The command standard output returned: always - type: string + type: str sample: 'Clustering node rabbit@slave1 with rabbit@master ...' stderr: description: The command standard error returned: always - type: string + type: str sample: 'ls: cannot access foo: No such file or directory' cmd: description: The command executed by the task returned: always - type: string + type: str sample: 'rabbitmqctl join_cluster rabbit@master' rc: description: The command return code (0 means success) diff --git a/lib/ansible/modules/windows/win_stat.py b/lib/ansible/modules/windows/win_stat.py index 6924bcb95c..e8a317d799 100644 --- a/lib/ansible/modules/windows/win_stat.py +++ b/lib/ansible/modules/windows/win_stat.py @@ -105,7 +105,7 @@ RETURN = r''' changed: description: Whether anything was changed returned: always - type: boolean + type: bool sample: True stat: description: dictionary containing all the stat data @@ -115,13 +115,13 @@ stat: attributes: description: Attributes of the file at path in raw form returned: success, path exists - type: string + type: str sample: "Archive, Hidden" checksum: description: The checksum of a file based on checksum_algorithm specified returned: success, path exist, path is a file, get_checksum == True checksum_algorithm specified is supported - type: string + type: str sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98 creationtime: description: The create time of the file represented in seconds since epoch @@ -131,17 +131,17 @@ stat: exists: description: If the path exists or not returned: success - type: boolean + type: bool sample: True extension: description: The extension of the file at path returned: success, path exists, path is a file - type: string + type: str sample: ".ps1" filename: description: The name of the file (without path) returned: success, path exists, path is a file - type: string + type: str sammple: foo.ini hlnk_targets: description: List of other files pointing to the same file (hard links), excludes the current file @@ -153,42 +153,42 @@ stat: isarchive: description: If the path is ready for archiving or not returned: success, path exists - type: boolean + type: bool sample: True isdir: description: If the path is a directory or not returned: success, path exists - type: boolean + type: bool sample: True ishidden: description: If the path is hidden or not returned: success, path exists - type: boolean + type: bool sample: True isjunction: description: If the path is a junction point or not returned: success, path exists - type: boolean + type: bool sample: True islnk: description: If the path is a symbolic link or not returned: success, path exists - type: boolean + type: bool sample: True isreadonly: description: If the path is read only or not returned: success, path exists - type: boolean + type: bool sample: True isreg: description: If the path is a regular file returned: success, path exists - type: boolean + type: bool sample: True isshared: description: If the path is shared or not returned: success, path exists - type: boolean + type: bool sample: True lastaccesstime: description: The last access time of the file represented in seconds since epoch @@ -203,17 +203,17 @@ stat: lnk_source: description: Target of the symlink normalized for the remote filesystem returned: success, path exists and the path is a symbolic link or junction point - type: string + type: str sample: C:\temp\link lnk_target: description: Target of the symlink. Note that relative paths remain relative returned: success, path exists and the path is a symbolic link or junction point - type: string + type: str sample: ..\link md5: description: The MD5 checksum of a file (Between Ansible 1.9 and 2.2 this was returned as a SHA1 hash), will be removed in 2.9 returned: success, path exist, path is a file, get_md5 == True - type: string + type: str sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98 nlink: description: Number of links to the file (hard links) @@ -223,17 +223,17 @@ stat: owner: description: The owner of the file returned: success, path exists - type: string + type: str sample: BUILTIN\Administrators path: description: The full absolute path to the file returned: success, path exists, file exists - type: string + type: str sample: C:\foo.ini sharename: description: The name of share if folder is shared returned: success, path exists, file is a directory and isshared == True - type: string + type: str sample: file-share size: description: The size in bytes of a file or folder diff --git a/lib/ansible/modules/windows/win_tempfile.py b/lib/ansible/modules/windows/win_tempfile.py index 4b4b5a2c07..2fce96585d 100644 --- a/lib/ansible/modules/windows/win_tempfile.py +++ b/lib/ansible/modules/windows/win_tempfile.py @@ -60,6 +60,6 @@ RETURN = r''' path: description: Path to created file or directory returned: success - type: string + type: str sample: C:\Users\Administrator\AppData\Local\Temp\ansible.bMlvdk ''' diff --git a/lib/ansible/modules/windows/win_timezone.py b/lib/ansible/modules/windows/win_timezone.py index 470f163248..b913a30869 100644 --- a/lib/ansible/modules/windows/win_timezone.py +++ b/lib/ansible/modules/windows/win_timezone.py @@ -52,11 +52,11 @@ RETURN = r''' previous_timezone: description: The previous timezone if it was changed, otherwise the existing timezone returned: success - type: string + type: str sample: Central Standard Time timezone: description: The current timezone (possibly changed) returned: success - type: string + type: str sample: Central Standard Time ''' diff --git a/lib/ansible/modules/windows/win_toast.py b/lib/ansible/modules/windows/win_toast.py index ae7ed6a332..cbbbd34d3f 100644 --- a/lib/ansible/modules/windows/win_toast.py +++ b/lib/ansible/modules/windows/win_toast.py @@ -73,17 +73,17 @@ RETURN = r''' expire_at_utc: description: Calculated utc date time when the notification expires. returned: allways - type: string + type: str sample: 07 July 2017 04:50:54 no_toast_sent_reason: description: Text containing the reason why a notification was not sent. returned: when no logged in users are detected - type: string + type: str sample: No logged in users to notify sent_localtime: description: local date time when the notification was sent. returned: allways - type: string + type: str sample: 07 July 2017 05:45:54 time_taken: description: How long the module took to run on the remote windows host in seconds. @@ -93,6 +93,6 @@ time_taken: toast_sent: description: Whether the module was able to send a toast notification or not. returned: allways - type: boolean + type: bool sample: false ''' diff --git a/lib/ansible/modules/windows/win_unzip.py b/lib/ansible/modules/windows/win_unzip.py index ef20893b39..4fde5c6c4d 100644 --- a/lib/ansible/modules/windows/win_unzip.py +++ b/lib/ansible/modules/windows/win_unzip.py @@ -99,16 +99,16 @@ RETURN = r''' dest: description: The provided destination path returned: always - type: string + type: str sample: C:\ExtractedLogs\application-error-logs removed: description: Whether the module did remove any files during task run returned: always - type: boolean + type: bool sample: True src: description: The provided source path returned: always - type: string + type: str sample: C:\Logs\application-error-logs.gz ''' diff --git a/lib/ansible/modules/windows/win_updates.py b/lib/ansible/modules/windows/win_updates.py index 9cd345fb29..c948d76421 100644 --- a/lib/ansible/modules/windows/win_updates.py +++ b/lib/ansible/modules/windows/win_updates.py @@ -174,7 +174,7 @@ RETURN = r''' reboot_required: description: True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot) returned: success - type: boolean + type: bool sample: True updates: @@ -186,7 +186,7 @@ updates: title: description: Display name returned: always - type: string + type: str sample: "Security Update for Windows Server 2012 R2 (KB3004365)" kb: description: A list of KB article IDs that apply to the update @@ -196,12 +196,12 @@ updates: id: description: Internal Windows Update GUID returned: always - type: string (guid) + type: str (guid) sample: "fb95c1c8-de23-4089-ae29-fd3351d55421" installed: description: Was the update successfully installed returned: always - type: boolean + type: bool sample: True categories: description: A list of category strings for this update @@ -211,7 +211,7 @@ updates: failure_hresult_code: description: The HRESULT code from a failed update returned: on install failure - type: boolean + type: bool sample: 2147942402 filtered_updates: @@ -225,7 +225,7 @@ filtered_updates: filtered_reason: description: The reason why this update was filtered returned: always - type: string + type: str sample: 'skip_hidden' found_update_count: diff --git a/lib/ansible/modules/windows/win_uri.py b/lib/ansible/modules/windows/win_uri.py index a414256929..dcdb037fb1 100644 --- a/lib/ansible/modules/windows/win_uri.py +++ b/lib/ansible/modules/windows/win_uri.py @@ -185,7 +185,7 @@ elapsed: url: description: The Target URL returned: always - type: string + type: str sample: https://www.ansible.com status_code: description: The HTTP Status Code of the response. @@ -195,12 +195,12 @@ status_code: status_description: description: A summary of the status. returned: success - type: string + type: str sample: OK content: description: The raw content of the HTTP response. returned: success and return_content is True - type: string + type: str sample: '{"foo": "bar"}' content_length: description: The byte size of the response. diff --git a/lib/ansible/modules/windows/win_xml.py b/lib/ansible/modules/windows/win_xml.py index 08bf23aea2..40396a07ba 100644 --- a/lib/ansible/modules/windows/win_xml.py +++ b/lib/ansible/modules/windows/win_xml.py @@ -75,7 +75,7 @@ RETURN = r''' msg: description: what was done returned: always - type: string + type: str sample: "xml added" err: description: xml comparison exceptions @@ -85,6 +85,6 @@ err: backup: description: name of the backup file, if created returned: changed - type: string + type: str sample: C:\config.xml.19700101-000000 ''' |