pyControl Get File From BIG-IP

Problem this snippet solves:

This pyControl v2 script downloads the specified BIGIP file to the specified file location.

How to use this snippet:


Usage: < host> < username> < BIGIP Filename> < Local Filename>


Code :

#!/bin/env python
 The contents of this file are subject to the "END USER LICENSE AGREEMENT FOR F5
 Software Development Kit for iControl"; you may not use this file except in
 compliance with the License. The License is included in the iControl
 Software Development Kit.

 Software distributed under the License is distributed on an "AS IS"
 basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 the License for the specific language governing rights and limitations
 under the License.

 The Original Code is iControl Code and related documentation
 distributed by F5.

 The Initial Developer of the Original Code is F5 Networks,
 Inc. Seattle, WA, USA. Portions created by F5 are Copyright (C) 1996-2004 F5 Networks,
 Inc. All Rights Reserved.  iControl (TM) is a registered trademark of F5 Networks, Inc.

 Alternatively, the contents of this file may be used under the terms
 of the GNU General Public License (the "GPL"), in which case the
 provisions of GPL are applicable instead of those above.  If you wish
 to allow use of your version of this file only under the terms of the
 GPL and not to allow others to use your version of this file under the
 License, indicate your decision by deleting the provisions above and
 replace them with the notice and other provisions required by the GPL.
 If you do not delete the provisions above, a recipient may use your
 version of this file under either the License or the GPL.

import base64
import binascii
import io

def pc_downloader(b,remote_file,local_file):
    stream_io =,'wb')
    dl = b.System.ConfigSync
    poll = True
    chunk_size = 64*1024
    foffset = 0
    lines = []

    while poll:
        res = dl.download_file(file_name = remote_file, chunk_size = chunk_size, file_offset = foffset)
        foffset = long(res.file_offset)
        fdata = getattr(res,'return').file_data
        chain_type = getattr(res, 'return').chain_type
        if (chain_type == 'FILE_LAST') or (chain_type == 'FILE_FIRST_AND_LAST'):
            poll = False

if __name__ == '__main__':

    import pycontrol.pycontrol as pc
    import base64
    import binascii
    import io
    import getpass
    import sys

    if pc.__version__[:3] == '2.0':
    print "Requires pycontrol v2.x!"

    if len(sys.argv) != 5:
    exit("Usage:    ")

    host = sys.argv[1]
    uname = sys.argv[2]
    remote_file = sys.argv[3]
    local_file = sys.argv[4]

    upass = getpass.getpass()

    b = pc.BIGIP(
        hostname = host,
username = uname,
password = upass,
fromurl = True,
wsdls = ['System.ConfigSync']

Published Mar 09, 2015
Version 1.0

Was this article helpful?

No CommentsBe the first to comment