community.lbry.lbry_account_balance (0.1.1) — module

Return the balance of an account.

| "added in version" 1.0.0 of community.lbry"

Authors: Rhys Campbell (@rhysmeister)

Install collection

Install with ansible-galaxy collection install community.lbry:==0.1.1


Add to requirements.yml

  collections:
    - name: community.lbry
      version: 0.1.1

Description

Return the balance of an account.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get balance for an account
  community.lbry.lbry_account_balance:
    account_id: myaccount
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Wait for the available balance to hit an expected level
  community.lbry.lbry_account_balance:
  register: account
  retries: 99
  delay: 10
  until: "account.balance.available == '200.0'"

Inputs

    
host:
    aliases:
    - login_host
    default: 127.0.0.1
    description:
    - The LBRY SDK Server Hostname.
    type: str

port:
    aliases:
    - login_port
    default: 5279
    description:
    - The LBRY SDK Server Port.
    type: int

debug:
    default: false
    description:
    - Show additional debug output.
    type: bool

protocol:
    default: http
    description:
    - The LBRY SDK Server Protocol.
    type: str

wallet_id:
    description:
    - wallet file name
    type: str

account_id:
    aliases:
    - name
    description:
    - If provided only the balance for this account will be given.
    - Otherwise default account is assumed.
    type: str

confirmations:
    description:
    - Only include transactions with this many confirmed blocks.
    type: int

Outputs

balance:
  description: Account balance info.
  returned: always
  sample:
    available: '0.0'
    reserved: '0.0'
    reserved_subtotals:
      claims: '0.0'
      supports: '0.0'
      tips: '0.0'
    total: '0.0'
  type: dict